Smartlead

Usage Instructions

Integrate Smartlead into workflows. Create campaigns, write multi-step email sequences, import and categorize leads, pull campaign analytics, and register webhooks for engagement events.

Actions

Smartlead List Campaigns

Retrieves all Smartlead campaigns for the authenticated account.

Input

Parameter	Type	Required	Description
`clientId`	number	No	Only return campaigns for this client (agency accounts)
`includeTags`	boolean	No	Include campaign tags in the response

Output

Parameter	Type	Description
`campaigns`	array	List of campaigns
`leads`	array	List of leads
`sequences`	array	Email sequence steps
`categories`	array	Lead categories
`webhooks`	array	Campaign webhooks
`stats`	array	Per-email statistics rows
`history`	array	Lead message history
`count`	number	Number of records returned
`total_leads`	number	Total leads in the campaign, or leads newly added when importing
`total_stats`	number	Total statistics rows matching the filters
`id`	number	Record ID
`name`	string	Record name
`status`	string	Campaign status
`email`	string	Lead email address
`webhook_url`	string	Webhook destination URL
`event_types`	array	Webhook event types
`sent_count`	number	Emails sent
`open_count`	number	Email opens
`click_count`	number	Link clicks
`reply_count`	number	Replies
`bounce_count`	number	Bounces
`campaign_lead_stats`	json	Lead counts by state
`upload_count`	number	Leads submitted in the request
`success`	boolean	Whether the action succeeded
`items`	array	Records returned by Smartlead
`rows`	array	Rows returned by Smartlead
`lists`	array	Lead lists
`summary`	array	Webhook delivery summary rows
`csv`	string	Exported leads as CSV
`row_count`	number	Rows in the exported CSV
`has_more`	boolean	Whether more rows are available
`list_name`	string	Lead list name
`positive_reply_count`	number	Replies categorized as positive
`offset`	number	Pagination offset used
`limit`	number	Pagination limit used
`total_count`	number	Total records matching the request
`from`	string	Start of the reported window
`to`	string	End of the reported window
`start_date`	string	Start of the reported range
`end_date`	string	End of the reported range
`skipped_count`	number	Emails skipped
`failed_count`	number	Failed sends
`stopped_count`	number	Stopped leads
`unsubscribed_count`	number	Unsubscribes
`unique_sent_count`	number	Unique leads emailed
`unique_open_count`	number	Unique opens
`unique_click_count`	number	Unique clicks
`block_count`	number	Blocked sends, or leads skipped by the block list
`drafted_count`	number	Drafted emails
`sequence_count`	number	Sequence steps in the campaign
`duplicate_count`	number	Duplicate leads skipped on import
`invalid_email_count`	number	Leads skipped for an invalid email
`invalid_emails`	array	Emails rejected as invalid
`already_added_to_campaign`	number	Leads already in the campaign
`unsubscribed_leads`	array	Leads skipped because they unsubscribed
`lead_import_stopped_count`	number	Leads whose import was stopped
`is_lead_limit_exhausted`	boolean	Whether the plan lead limit was hit
`is_last_sequence`	boolean	Whether the lead was on the final step
`next_sequence_id`	number	ID of the next sequence step
`next_sequence_delay_in_days`	number	Days before the next step
`first_name`	string	Lead first name
`last_name`	string	Lead last name
`phone_number`	string	Lead phone number
`company_name`	string	Lead company name
`website`	string	Lead website
`location`	string	Lead location
`linkedin_profile`	string	Lead LinkedIn profile URL
`company_url`	string	Lead company URL
`custom_fields`	json	Lead custom fields
`is_unsubscribed`	boolean	Whether the lead is unsubscribed
`lead_campaign_data`	array	Campaigns the lead belongs to
`created_at`	string	Creation timestamp
`updated_at`	string	Last update timestamp
`leads_count`	number	Leads in the list
`active_leads_count`	number	Active leads in the list
`track_settings`	array	Disabled tracking settings
`scheduler_cron_value`	json	Campaign sending schedule
`accounts`	array	Sending email accounts, excluding their stored mailbox credentials
`user_id`	number	Owning Smartlead user ID
`min_time_btwn_emails`	number	Minimum minutes between emails
`max_leads_per_day`	number	Maximum new leads per day
`stop_lead_settings`	string	Activity that stops a lead sequence
`schedule_start_time`	string	Scheduled start time
`enable_ai_esp_matching`	boolean	Whether AI ESP matching is enabled
`send_as_plain_text`	boolean	Whether emails send as plain text
`follow_up_percentage`	number	Follow-up percentage
`unsubscribe_text`	string	Unsubscribe text
`parent_campaign_id`	number	Parent campaign ID
`client_id`	number	Client ID for agency accounts
`client_name`	string	Client name
`client_email`	string	Client email
`client_company_name`	string	Client company name
`tags`	array	Tags on the record
`email_campaign_id`	number	Campaign the webhook belongs to

Smartlead Get Campaign

Retrieves a single Smartlead campaign by ID.

Input

Parameter	Type	Required	Description

Output

Parameter	Type	Description
`campaigns`	array	List of campaigns
`leads`	array	List of leads
`sequences`	array	Email sequence steps
`categories`	array	Lead categories
`webhooks`	array	Campaign webhooks
`stats`	array	Per-email statistics rows
`history`	array	Lead message history
`count`	number	Number of records returned
`total_leads`	number	Total leads in the campaign, or leads newly added when importing
`total_stats`	number	Total statistics rows matching the filters
`id`	number	Record ID
`name`	string	Record name
`status`	string	Campaign status
`email`	string	Lead email address
`webhook_url`	string	Webhook destination URL
`event_types`	array	Webhook event types
`sent_count`	number	Emails sent
`open_count`	number	Email opens
`click_count`	number	Link clicks
`reply_count`	number	Replies
`bounce_count`	number	Bounces
`campaign_lead_stats`	json	Lead counts by state
`upload_count`	number	Leads submitted in the request
`success`	boolean	Whether the action succeeded
`items`	array	Records returned by Smartlead
`rows`	array	Rows returned by Smartlead
`lists`	array	Lead lists
`summary`	array	Webhook delivery summary rows
`csv`	string	Exported leads as CSV
`row_count`	number	Rows in the exported CSV
`has_more`	boolean	Whether more rows are available
`list_name`	string	Lead list name
`positive_reply_count`	number	Replies categorized as positive
`offset`	number	Pagination offset used
`limit`	number	Pagination limit used
`total_count`	number	Total records matching the request
`from`	string	Start of the reported window
`to`	string	End of the reported window
`start_date`	string	Start of the reported range
`end_date`	string	End of the reported range
`skipped_count`	number	Emails skipped
`failed_count`	number	Failed sends
`stopped_count`	number	Stopped leads
`unsubscribed_count`	number	Unsubscribes
`unique_sent_count`	number	Unique leads emailed
`unique_open_count`	number	Unique opens
`unique_click_count`	number	Unique clicks
`block_count`	number	Blocked sends, or leads skipped by the block list
`drafted_count`	number	Drafted emails
`sequence_count`	number	Sequence steps in the campaign
`duplicate_count`	number	Duplicate leads skipped on import
`invalid_email_count`	number	Leads skipped for an invalid email
`invalid_emails`	array	Emails rejected as invalid
`already_added_to_campaign`	number	Leads already in the campaign
`unsubscribed_leads`	array	Leads skipped because they unsubscribed
`lead_import_stopped_count`	number	Leads whose import was stopped
`is_lead_limit_exhausted`	boolean	Whether the plan lead limit was hit
`is_last_sequence`	boolean	Whether the lead was on the final step
`next_sequence_id`	number	ID of the next sequence step
`next_sequence_delay_in_days`	number	Days before the next step
`first_name`	string	Lead first name
`last_name`	string	Lead last name
`phone_number`	string	Lead phone number
`company_name`	string	Lead company name
`website`	string	Lead website
`location`	string	Lead location
`linkedin_profile`	string	Lead LinkedIn profile URL
`company_url`	string	Lead company URL
`custom_fields`	json	Lead custom fields
`is_unsubscribed`	boolean	Whether the lead is unsubscribed
`lead_campaign_data`	array	Campaigns the lead belongs to
`created_at`	string	Creation timestamp
`updated_at`	string	Last update timestamp
`leads_count`	number	Leads in the list
`active_leads_count`	number	Active leads in the list
`track_settings`	array	Disabled tracking settings
`scheduler_cron_value`	json	Campaign sending schedule
`accounts`	array	Sending email accounts, excluding their stored mailbox credentials
`user_id`	number	Owning Smartlead user ID
`min_time_btwn_emails`	number	Minimum minutes between emails
`max_leads_per_day`	number	Maximum new leads per day
`stop_lead_settings`	string	Activity that stops a lead sequence
`schedule_start_time`	string	Scheduled start time
`enable_ai_esp_matching`	boolean	Whether AI ESP matching is enabled
`send_as_plain_text`	boolean	Whether emails send as plain text
`follow_up_percentage`	number	Follow-up percentage
`unsubscribe_text`	string	Unsubscribe text
`parent_campaign_id`	number	Parent campaign ID
`client_id`	number	Client ID for agency accounts
`client_name`	string	Client name
`client_email`	string	Client email
`client_company_name`	string	Client company name
`tags`	array	Tags on the record
`email_campaign_id`	number	Campaign the webhook belongs to

Smartlead Create Campaign

Creates a Smartlead campaign. The campaign starts in DRAFTED status; add sequences, email accounts, and a schedule before starting it.

Input

Parameter	Type	Required	Description
`name`	string	Yes	Campaign name
`clientId`	number	No	Client to own the campaign (agency accounts)

Output

Parameter	Type	Description
`campaigns`	array	List of campaigns
`leads`	array	List of leads
`sequences`	array	Email sequence steps
`categories`	array	Lead categories
`webhooks`	array	Campaign webhooks
`stats`	array	Per-email statistics rows
`history`	array	Lead message history
`count`	number	Number of records returned
`total_leads`	number	Total leads in the campaign, or leads newly added when importing
`total_stats`	number	Total statistics rows matching the filters
`id`	number	Record ID
`name`	string	Record name
`status`	string	Campaign status
`email`	string	Lead email address
`webhook_url`	string	Webhook destination URL
`event_types`	array	Webhook event types
`sent_count`	number	Emails sent
`open_count`	number	Email opens
`click_count`	number	Link clicks
`reply_count`	number	Replies
`bounce_count`	number	Bounces
`campaign_lead_stats`	json	Lead counts by state
`upload_count`	number	Leads submitted in the request
`success`	boolean	Whether the action succeeded
`items`	array	Records returned by Smartlead
`rows`	array	Rows returned by Smartlead
`lists`	array	Lead lists
`summary`	array	Webhook delivery summary rows
`csv`	string	Exported leads as CSV
`row_count`	number	Rows in the exported CSV
`has_more`	boolean	Whether more rows are available
`list_name`	string	Lead list name
`positive_reply_count`	number	Replies categorized as positive
`offset`	number	Pagination offset used
`limit`	number	Pagination limit used
`total_count`	number	Total records matching the request
`from`	string	Start of the reported window
`to`	string	End of the reported window
`start_date`	string	Start of the reported range
`end_date`	string	End of the reported range
`skipped_count`	number	Emails skipped
`failed_count`	number	Failed sends
`stopped_count`	number	Stopped leads
`unsubscribed_count`	number	Unsubscribes
`unique_sent_count`	number	Unique leads emailed
`unique_open_count`	number	Unique opens
`unique_click_count`	number	Unique clicks
`block_count`	number	Blocked sends, or leads skipped by the block list
`drafted_count`	number	Drafted emails
`sequence_count`	number	Sequence steps in the campaign
`duplicate_count`	number	Duplicate leads skipped on import
`invalid_email_count`	number	Leads skipped for an invalid email
`invalid_emails`	array	Emails rejected as invalid
`already_added_to_campaign`	number	Leads already in the campaign
`unsubscribed_leads`	array	Leads skipped because they unsubscribed
`lead_import_stopped_count`	number	Leads whose import was stopped
`is_lead_limit_exhausted`	boolean	Whether the plan lead limit was hit
`is_last_sequence`	boolean	Whether the lead was on the final step
`next_sequence_id`	number	ID of the next sequence step
`next_sequence_delay_in_days`	number	Days before the next step
`first_name`	string	Lead first name
`last_name`	string	Lead last name
`phone_number`	string	Lead phone number
`company_name`	string	Lead company name
`website`	string	Lead website
`location`	string	Lead location
`linkedin_profile`	string	Lead LinkedIn profile URL
`company_url`	string	Lead company URL
`custom_fields`	json	Lead custom fields
`is_unsubscribed`	boolean	Whether the lead is unsubscribed
`lead_campaign_data`	array	Campaigns the lead belongs to
`created_at`	string	Creation timestamp
`updated_at`	string	Last update timestamp
`leads_count`	number	Leads in the list
`active_leads_count`	number	Active leads in the list
`track_settings`	array	Disabled tracking settings
`scheduler_cron_value`	json	Campaign sending schedule
`accounts`	array	Sending email accounts, excluding their stored mailbox credentials
`user_id`	number	Owning Smartlead user ID
`min_time_btwn_emails`	number	Minimum minutes between emails
`max_leads_per_day`	number	Maximum new leads per day
`stop_lead_settings`	string	Activity that stops a lead sequence
`schedule_start_time`	string	Scheduled start time
`enable_ai_esp_matching`	boolean	Whether AI ESP matching is enabled
`send_as_plain_text`	boolean	Whether emails send as plain text
`follow_up_percentage`	number	Follow-up percentage
`unsubscribe_text`	string	Unsubscribe text
`parent_campaign_id`	number	Parent campaign ID
`client_id`	number	Client ID for agency accounts
`client_name`	string	Client name
`client_email`	string	Client email
`client_company_name`	string	Client company name
`tags`	array	Tags on the record
`email_campaign_id`	number	Campaign the webhook belongs to

Smartlead Update Campaign Status

Starts, pauses, or stops a Smartlead campaign. START requires the campaign to already have a schedule, sequences, and at least one email account.

Input

Parameter	Type	Required	Description
`status`	string	Yes	Target status: START, PAUSED, STOPPED

Output

Parameter	Type	Description
`campaigns`	array	List of campaigns
`leads`	array	List of leads
`sequences`	array	Email sequence steps
`categories`	array	Lead categories
`webhooks`	array	Campaign webhooks
`stats`	array	Per-email statistics rows
`history`	array	Lead message history
`count`	number	Number of records returned
`total_leads`	number	Total leads in the campaign, or leads newly added when importing
`total_stats`	number	Total statistics rows matching the filters
`id`	number	Record ID
`name`	string	Record name
`status`	string	Campaign status
`email`	string	Lead email address
`webhook_url`	string	Webhook destination URL
`event_types`	array	Webhook event types
`sent_count`	number	Emails sent
`open_count`	number	Email opens
`click_count`	number	Link clicks
`reply_count`	number	Replies
`bounce_count`	number	Bounces
`campaign_lead_stats`	json	Lead counts by state
`upload_count`	number	Leads submitted in the request
`success`	boolean	Whether the action succeeded
`items`	array	Records returned by Smartlead
`rows`	array	Rows returned by Smartlead
`lists`	array	Lead lists
`summary`	array	Webhook delivery summary rows
`csv`	string	Exported leads as CSV
`row_count`	number	Rows in the exported CSV
`has_more`	boolean	Whether more rows are available
`list_name`	string	Lead list name
`positive_reply_count`	number	Replies categorized as positive
`offset`	number	Pagination offset used
`limit`	number	Pagination limit used
`total_count`	number	Total records matching the request
`from`	string	Start of the reported window
`to`	string	End of the reported window
`start_date`	string	Start of the reported range
`end_date`	string	End of the reported range
`skipped_count`	number	Emails skipped
`failed_count`	number	Failed sends
`stopped_count`	number	Stopped leads
`unsubscribed_count`	number	Unsubscribes
`unique_sent_count`	number	Unique leads emailed
`unique_open_count`	number	Unique opens
`unique_click_count`	number	Unique clicks
`block_count`	number	Blocked sends, or leads skipped by the block list
`drafted_count`	number	Drafted emails
`sequence_count`	number	Sequence steps in the campaign
`duplicate_count`	number	Duplicate leads skipped on import
`invalid_email_count`	number	Leads skipped for an invalid email
`invalid_emails`	array	Emails rejected as invalid
`already_added_to_campaign`	number	Leads already in the campaign
`unsubscribed_leads`	array	Leads skipped because they unsubscribed
`lead_import_stopped_count`	number	Leads whose import was stopped
`is_lead_limit_exhausted`	boolean	Whether the plan lead limit was hit
`is_last_sequence`	boolean	Whether the lead was on the final step
`next_sequence_id`	number	ID of the next sequence step
`next_sequence_delay_in_days`	number	Days before the next step
`first_name`	string	Lead first name
`last_name`	string	Lead last name
`phone_number`	string	Lead phone number
`company_name`	string	Lead company name
`website`	string	Lead website
`location`	string	Lead location
`linkedin_profile`	string	Lead LinkedIn profile URL
`company_url`	string	Lead company URL
`custom_fields`	json	Lead custom fields
`is_unsubscribed`	boolean	Whether the lead is unsubscribed
`lead_campaign_data`	array	Campaigns the lead belongs to
`created_at`	string	Creation timestamp
`updated_at`	string	Last update timestamp
`leads_count`	number	Leads in the list
`active_leads_count`	number	Active leads in the list
`track_settings`	array	Disabled tracking settings
`scheduler_cron_value`	json	Campaign sending schedule
`accounts`	array	Sending email accounts, excluding their stored mailbox credentials
`user_id`	number	Owning Smartlead user ID
`min_time_btwn_emails`	number	Minimum minutes between emails
`max_leads_per_day`	number	Maximum new leads per day
`stop_lead_settings`	string	Activity that stops a lead sequence
`schedule_start_time`	string	Scheduled start time
`enable_ai_esp_matching`	boolean	Whether AI ESP matching is enabled
`send_as_plain_text`	boolean	Whether emails send as plain text
`follow_up_percentage`	number	Follow-up percentage
`unsubscribe_text`	string	Unsubscribe text
`parent_campaign_id`	number	Parent campaign ID
`client_id`	number	Client ID for agency accounts
`client_name`	string	Client name
`client_email`	string	Client email
`client_company_name`	string	Client company name
`tags`	array	Tags on the record
`email_campaign_id`	number	Campaign the webhook belongs to

Smartlead Update Campaign Schedule

Sets the sending window, timezone, and throughput limits for a Smartlead campaign. A campaign cannot be started until a schedule exists.

Input

Parameter	Type	Required	Description
`timezone`	string	Yes	IANA timezone for the sending window, e.g. America/Los_Angeles
`daysOfTheWeek`	array	Yes	Sending days as ISO weekday numbers, where 1 is Monday and 7 is Sunday
`startHour`	string	Yes	Sending window start in 24-hour HH:MM format, e.g. 09:00
`endHour`	string	Yes	Sending window end in 24-hour HH:MM format, e.g. 17:00
`minTimeBetweenEmails`	number	No	Minimum minutes to wait between emails
`maxNewLeadsPerDay`	number	No	Maximum new leads to contact per day
`scheduleStartTime`	string	No	ISO 8601 timestamp to begin sending, omit to start immediately

Output

Parameter	Type	Description
`campaigns`	array	List of campaigns
`leads`	array	List of leads
`sequences`	array	Email sequence steps
`categories`	array	Lead categories
`webhooks`	array	Campaign webhooks
`stats`	array	Per-email statistics rows
`history`	array	Lead message history
`count`	number	Number of records returned
`total_leads`	number	Total leads in the campaign, or leads newly added when importing
`total_stats`	number	Total statistics rows matching the filters
`id`	number	Record ID
`name`	string	Record name
`status`	string	Campaign status
`email`	string	Lead email address
`webhook_url`	string	Webhook destination URL
`event_types`	array	Webhook event types
`sent_count`	number	Emails sent
`open_count`	number	Email opens
`click_count`	number	Link clicks
`reply_count`	number	Replies
`bounce_count`	number	Bounces
`campaign_lead_stats`	json	Lead counts by state
`upload_count`	number	Leads submitted in the request
`success`	boolean	Whether the action succeeded
`items`	array	Records returned by Smartlead
`rows`	array	Rows returned by Smartlead
`lists`	array	Lead lists
`summary`	array	Webhook delivery summary rows
`csv`	string	Exported leads as CSV
`row_count`	number	Rows in the exported CSV
`has_more`	boolean	Whether more rows are available
`list_name`	string	Lead list name
`positive_reply_count`	number	Replies categorized as positive
`offset`	number	Pagination offset used
`limit`	number	Pagination limit used
`total_count`	number	Total records matching the request
`from`	string	Start of the reported window
`to`	string	End of the reported window
`start_date`	string	Start of the reported range
`end_date`	string	End of the reported range
`skipped_count`	number	Emails skipped
`failed_count`	number	Failed sends
`stopped_count`	number	Stopped leads
`unsubscribed_count`	number	Unsubscribes
`unique_sent_count`	number	Unique leads emailed
`unique_open_count`	number	Unique opens
`unique_click_count`	number	Unique clicks
`block_count`	number	Blocked sends, or leads skipped by the block list
`drafted_count`	number	Drafted emails
`sequence_count`	number	Sequence steps in the campaign
`duplicate_count`	number	Duplicate leads skipped on import
`invalid_email_count`	number	Leads skipped for an invalid email
`invalid_emails`	array	Emails rejected as invalid
`already_added_to_campaign`	number	Leads already in the campaign
`unsubscribed_leads`	array	Leads skipped because they unsubscribed
`lead_import_stopped_count`	number	Leads whose import was stopped
`is_lead_limit_exhausted`	boolean	Whether the plan lead limit was hit
`is_last_sequence`	boolean	Whether the lead was on the final step
`next_sequence_id`	number	ID of the next sequence step
`next_sequence_delay_in_days`	number	Days before the next step
`first_name`	string	Lead first name
`last_name`	string	Lead last name
`phone_number`	string	Lead phone number
`company_name`	string	Lead company name
`website`	string	Lead website
`location`	string	Lead location
`linkedin_profile`	string	Lead LinkedIn profile URL
`company_url`	string	Lead company URL
`custom_fields`	json	Lead custom fields
`is_unsubscribed`	boolean	Whether the lead is unsubscribed
`lead_campaign_data`	array	Campaigns the lead belongs to
`created_at`	string	Creation timestamp
`updated_at`	string	Last update timestamp
`leads_count`	number	Leads in the list
`active_leads_count`	number	Active leads in the list
`track_settings`	array	Disabled tracking settings
`scheduler_cron_value`	json	Campaign sending schedule
`accounts`	array	Sending email accounts, excluding their stored mailbox credentials
`user_id`	number	Owning Smartlead user ID
`min_time_btwn_emails`	number	Minimum minutes between emails
`max_leads_per_day`	number	Maximum new leads per day
`stop_lead_settings`	string	Activity that stops a lead sequence
`schedule_start_time`	string	Scheduled start time
`enable_ai_esp_matching`	boolean	Whether AI ESP matching is enabled
`send_as_plain_text`	boolean	Whether emails send as plain text
`follow_up_percentage`	number	Follow-up percentage
`unsubscribe_text`	string	Unsubscribe text
`parent_campaign_id`	number	Parent campaign ID
`client_id`	number	Client ID for agency accounts
`client_name`	string	Client name
`client_email`	string	Client email
`client_company_name`	string	Client company name
`tags`	array	Tags on the record
`email_campaign_id`	number	Campaign the webhook belongs to

Smartlead Update Campaign Settings

Updates tracking, stop-on-activity, and sending settings for a Smartlead campaign.

Input

Parameter	Type	Required	Description
`trackSettings`	array	No	Tracking to disable. Allowed values: DONT_TRACK_EMAIL_OPEN, DONT_TRACK_LINK_CLICK, DONT_TRACK_REPLY_TO_AN_EMAIL
`stopLeadSettings`	string	No	Lead activity that stops the sequence: REPLY_TO_AN_EMAIL, CLICK_ON_A_LINK, OPEN_AN_EMAIL
`sendAsPlainText`	boolean	No	Send campaign emails as plain text
`followUpPercentage`	number	No	Percentage of leads that receive follow-ups
`unsubscribeText`	string	No	Unsubscribe text appended to emails
`enableAiEspMatching`	boolean	No	Match sending accounts to recipient email providers

Output

Parameter	Type	Description
`campaigns`	array	List of campaigns
`leads`	array	List of leads
`sequences`	array	Email sequence steps
`categories`	array	Lead categories
`webhooks`	array	Campaign webhooks
`stats`	array	Per-email statistics rows
`history`	array	Lead message history
`count`	number	Number of records returned
`total_leads`	number	Total leads in the campaign, or leads newly added when importing
`total_stats`	number	Total statistics rows matching the filters
`id`	number	Record ID
`name`	string	Record name
`status`	string	Campaign status
`email`	string	Lead email address
`webhook_url`	string	Webhook destination URL
`event_types`	array	Webhook event types
`sent_count`	number	Emails sent
`open_count`	number	Email opens
`click_count`	number	Link clicks
`reply_count`	number	Replies
`bounce_count`	number	Bounces
`campaign_lead_stats`	json	Lead counts by state
`upload_count`	number	Leads submitted in the request
`success`	boolean	Whether the action succeeded
`items`	array	Records returned by Smartlead
`rows`	array	Rows returned by Smartlead
`lists`	array	Lead lists
`summary`	array	Webhook delivery summary rows
`csv`	string	Exported leads as CSV
`row_count`	number	Rows in the exported CSV
`has_more`	boolean	Whether more rows are available
`list_name`	string	Lead list name
`positive_reply_count`	number	Replies categorized as positive
`offset`	number	Pagination offset used
`limit`	number	Pagination limit used
`total_count`	number	Total records matching the request
`from`	string	Start of the reported window
`to`	string	End of the reported window
`start_date`	string	Start of the reported range
`end_date`	string	End of the reported range
`skipped_count`	number	Emails skipped
`failed_count`	number	Failed sends
`stopped_count`	number	Stopped leads
`unsubscribed_count`	number	Unsubscribes
`unique_sent_count`	number	Unique leads emailed
`unique_open_count`	number	Unique opens
`unique_click_count`	number	Unique clicks
`block_count`	number	Blocked sends, or leads skipped by the block list
`drafted_count`	number	Drafted emails
`sequence_count`	number	Sequence steps in the campaign
`duplicate_count`	number	Duplicate leads skipped on import
`invalid_email_count`	number	Leads skipped for an invalid email
`invalid_emails`	array	Emails rejected as invalid
`already_added_to_campaign`	number	Leads already in the campaign
`unsubscribed_leads`	array	Leads skipped because they unsubscribed
`lead_import_stopped_count`	number	Leads whose import was stopped
`is_lead_limit_exhausted`	boolean	Whether the plan lead limit was hit
`is_last_sequence`	boolean	Whether the lead was on the final step
`next_sequence_id`	number	ID of the next sequence step
`next_sequence_delay_in_days`	number	Days before the next step
`first_name`	string	Lead first name
`last_name`	string	Lead last name
`phone_number`	string	Lead phone number
`company_name`	string	Lead company name
`website`	string	Lead website
`location`	string	Lead location
`linkedin_profile`	string	Lead LinkedIn profile URL
`company_url`	string	Lead company URL
`custom_fields`	json	Lead custom fields
`is_unsubscribed`	boolean	Whether the lead is unsubscribed
`lead_campaign_data`	array	Campaigns the lead belongs to
`created_at`	string	Creation timestamp
`updated_at`	string	Last update timestamp
`leads_count`	number	Leads in the list
`active_leads_count`	number	Active leads in the list
`track_settings`	array	Disabled tracking settings
`scheduler_cron_value`	json	Campaign sending schedule
`accounts`	array	Sending email accounts, excluding their stored mailbox credentials
`user_id`	number	Owning Smartlead user ID
`min_time_btwn_emails`	number	Minimum minutes between emails
`max_leads_per_day`	number	Maximum new leads per day
`stop_lead_settings`	string	Activity that stops a lead sequence
`schedule_start_time`	string	Scheduled start time
`enable_ai_esp_matching`	boolean	Whether AI ESP matching is enabled
`send_as_plain_text`	boolean	Whether emails send as plain text
`follow_up_percentage`	number	Follow-up percentage
`unsubscribe_text`	string	Unsubscribe text
`parent_campaign_id`	number	Parent campaign ID
`client_id`	number	Client ID for agency accounts
`client_name`	string	Client name
`client_email`	string	Client email
`client_company_name`	string	Client company name
`tags`	array	Tags on the record
`email_campaign_id`	number	Campaign the webhook belongs to

Smartlead Get Campaign Analytics

Retrieves lifetime performance totals for a Smartlead campaign — sends, opens, clicks, replies, bounces, and lead counts by state.

Input

Parameter	Type	Required	Description

Output

Parameter	Type	Description
`campaigns`	array	List of campaigns
`leads`	array	List of leads
`sequences`	array	Email sequence steps
`categories`	array	Lead categories
`webhooks`	array	Campaign webhooks
`stats`	array	Per-email statistics rows
`history`	array	Lead message history
`count`	number	Number of records returned
`total_leads`	number	Total leads in the campaign, or leads newly added when importing
`total_stats`	number	Total statistics rows matching the filters
`id`	number	Record ID
`name`	string	Record name
`status`	string	Campaign status
`email`	string	Lead email address
`webhook_url`	string	Webhook destination URL
`event_types`	array	Webhook event types
`sent_count`	number	Emails sent
`open_count`	number	Email opens
`click_count`	number	Link clicks
`reply_count`	number	Replies
`bounce_count`	number	Bounces
`campaign_lead_stats`	json	Lead counts by state
`upload_count`	number	Leads submitted in the request
`success`	boolean	Whether the action succeeded
`items`	array	Records returned by Smartlead
`rows`	array	Rows returned by Smartlead
`lists`	array	Lead lists
`summary`	array	Webhook delivery summary rows
`csv`	string	Exported leads as CSV
`row_count`	number	Rows in the exported CSV
`has_more`	boolean	Whether more rows are available
`list_name`	string	Lead list name
`positive_reply_count`	number	Replies categorized as positive
`offset`	number	Pagination offset used
`limit`	number	Pagination limit used
`total_count`	number	Total records matching the request
`from`	string	Start of the reported window
`to`	string	End of the reported window
`start_date`	string	Start of the reported range
`end_date`	string	End of the reported range
`skipped_count`	number	Emails skipped
`failed_count`	number	Failed sends
`stopped_count`	number	Stopped leads
`unsubscribed_count`	number	Unsubscribes
`unique_sent_count`	number	Unique leads emailed
`unique_open_count`	number	Unique opens
`unique_click_count`	number	Unique clicks
`block_count`	number	Blocked sends, or leads skipped by the block list
`drafted_count`	number	Drafted emails
`sequence_count`	number	Sequence steps in the campaign
`duplicate_count`	number	Duplicate leads skipped on import
`invalid_email_count`	number	Leads skipped for an invalid email
`invalid_emails`	array	Emails rejected as invalid
`already_added_to_campaign`	number	Leads already in the campaign
`unsubscribed_leads`	array	Leads skipped because they unsubscribed
`lead_import_stopped_count`	number	Leads whose import was stopped
`is_lead_limit_exhausted`	boolean	Whether the plan lead limit was hit
`is_last_sequence`	boolean	Whether the lead was on the final step
`next_sequence_id`	number	ID of the next sequence step
`next_sequence_delay_in_days`	number	Days before the next step
`first_name`	string	Lead first name
`last_name`	string	Lead last name
`phone_number`	string	Lead phone number
`company_name`	string	Lead company name
`website`	string	Lead website
`location`	string	Lead location
`linkedin_profile`	string	Lead LinkedIn profile URL
`company_url`	string	Lead company URL
`custom_fields`	json	Lead custom fields
`is_unsubscribed`	boolean	Whether the lead is unsubscribed
`lead_campaign_data`	array	Campaigns the lead belongs to
`created_at`	string	Creation timestamp
`updated_at`	string	Last update timestamp
`leads_count`	number	Leads in the list
`active_leads_count`	number	Active leads in the list
`track_settings`	array	Disabled tracking settings
`scheduler_cron_value`	json	Campaign sending schedule
`accounts`	array	Sending email accounts, excluding their stored mailbox credentials
`user_id`	number	Owning Smartlead user ID
`min_time_btwn_emails`	number	Minimum minutes between emails
`max_leads_per_day`	number	Maximum new leads per day
`stop_lead_settings`	string	Activity that stops a lead sequence
`schedule_start_time`	string	Scheduled start time
`enable_ai_esp_matching`	boolean	Whether AI ESP matching is enabled
`send_as_plain_text`	boolean	Whether emails send as plain text
`follow_up_percentage`	number	Follow-up percentage
`unsubscribe_text`	string	Unsubscribe text
`parent_campaign_id`	number	Parent campaign ID
`client_id`	number	Client ID for agency accounts
`client_name`	string	Client name
`client_email`	string	Client email
`client_company_name`	string	Client company name
`tags`	array	Tags on the record
`email_campaign_id`	number	Campaign the webhook belongs to

Smartlead Get Campaign Analytics By Date

Retrieves Smartlead campaign performance totals for a date range. Smartlead rejects ranges longer than roughly one month.

Input

Parameter	Type	Required	Description
`startDate`	string	Yes	Range start date in YYYY-MM-DD format
`endDate`	string	Yes	Range end date in YYYY-MM-DD format

Output

Parameter	Type	Description
`campaigns`	array	List of campaigns
`leads`	array	List of leads
`sequences`	array	Email sequence steps
`categories`	array	Lead categories
`webhooks`	array	Campaign webhooks
`stats`	array	Per-email statistics rows
`history`	array	Lead message history
`count`	number	Number of records returned
`total_leads`	number	Total leads in the campaign, or leads newly added when importing
`total_stats`	number	Total statistics rows matching the filters
`id`	number	Record ID
`name`	string	Record name
`status`	string	Campaign status
`email`	string	Lead email address
`webhook_url`	string	Webhook destination URL
`event_types`	array	Webhook event types
`sent_count`	number	Emails sent
`open_count`	number	Email opens
`click_count`	number	Link clicks
`reply_count`	number	Replies
`bounce_count`	number	Bounces
`campaign_lead_stats`	json	Lead counts by state
`upload_count`	number	Leads submitted in the request
`success`	boolean	Whether the action succeeded
`items`	array	Records returned by Smartlead
`rows`	array	Rows returned by Smartlead
`lists`	array	Lead lists
`summary`	array	Webhook delivery summary rows
`csv`	string	Exported leads as CSV
`row_count`	number	Rows in the exported CSV
`has_more`	boolean	Whether more rows are available
`list_name`	string	Lead list name
`positive_reply_count`	number	Replies categorized as positive
`offset`	number	Pagination offset used
`limit`	number	Pagination limit used
`total_count`	number	Total records matching the request
`from`	string	Start of the reported window
`to`	string	End of the reported window
`start_date`	string	Start of the reported range
`end_date`	string	End of the reported range
`skipped_count`	number	Emails skipped
`failed_count`	number	Failed sends
`stopped_count`	number	Stopped leads
`unsubscribed_count`	number	Unsubscribes
`unique_sent_count`	number	Unique leads emailed
`unique_open_count`	number	Unique opens
`unique_click_count`	number	Unique clicks
`block_count`	number	Blocked sends, or leads skipped by the block list
`drafted_count`	number	Drafted emails
`sequence_count`	number	Sequence steps in the campaign
`duplicate_count`	number	Duplicate leads skipped on import
`invalid_email_count`	number	Leads skipped for an invalid email
`invalid_emails`	array	Emails rejected as invalid
`already_added_to_campaign`	number	Leads already in the campaign
`unsubscribed_leads`	array	Leads skipped because they unsubscribed
`lead_import_stopped_count`	number	Leads whose import was stopped
`is_lead_limit_exhausted`	boolean	Whether the plan lead limit was hit
`is_last_sequence`	boolean	Whether the lead was on the final step
`next_sequence_id`	number	ID of the next sequence step
`next_sequence_delay_in_days`	number	Days before the next step
`first_name`	string	Lead first name
`last_name`	string	Lead last name
`phone_number`	string	Lead phone number
`company_name`	string	Lead company name
`website`	string	Lead website
`location`	string	Lead location
`linkedin_profile`	string	Lead LinkedIn profile URL
`company_url`	string	Lead company URL
`custom_fields`	json	Lead custom fields
`is_unsubscribed`	boolean	Whether the lead is unsubscribed
`lead_campaign_data`	array	Campaigns the lead belongs to
`created_at`	string	Creation timestamp
`updated_at`	string	Last update timestamp
`leads_count`	number	Leads in the list
`active_leads_count`	number	Active leads in the list
`track_settings`	array	Disabled tracking settings
`scheduler_cron_value`	json	Campaign sending schedule
`accounts`	array	Sending email accounts, excluding their stored mailbox credentials
`user_id`	number	Owning Smartlead user ID
`min_time_btwn_emails`	number	Minimum minutes between emails
`max_leads_per_day`	number	Maximum new leads per day
`stop_lead_settings`	string	Activity that stops a lead sequence
`schedule_start_time`	string	Scheduled start time
`enable_ai_esp_matching`	boolean	Whether AI ESP matching is enabled
`send_as_plain_text`	boolean	Whether emails send as plain text
`follow_up_percentage`	number	Follow-up percentage
`unsubscribe_text`	string	Unsubscribe text
`parent_campaign_id`	number	Parent campaign ID
`client_id`	number	Client ID for agency accounts
`client_name`	string	Client name
`client_email`	string	Client email
`client_company_name`	string	Client company name
`tags`	array	Tags on the record
`email_campaign_id`	number	Campaign the webhook belongs to

Smartlead Get Campaign Sequences

Retrieves the email sequence steps for a Smartlead campaign, including subjects, bodies, and per-step delays.

Input

Parameter	Type	Required	Description

Output

Parameter	Type	Description
`campaigns`	array	List of campaigns
`leads`	array	List of leads
`sequences`	array	Email sequence steps
`categories`	array	Lead categories
`webhooks`	array	Campaign webhooks
`stats`	array	Per-email statistics rows
`history`	array	Lead message history
`count`	number	Number of records returned
`total_leads`	number	Total leads in the campaign, or leads newly added when importing
`total_stats`	number	Total statistics rows matching the filters
`id`	number	Record ID
`name`	string	Record name
`status`	string	Campaign status
`email`	string	Lead email address
`webhook_url`	string	Webhook destination URL
`event_types`	array	Webhook event types
`sent_count`	number	Emails sent
`open_count`	number	Email opens
`click_count`	number	Link clicks
`reply_count`	number	Replies
`bounce_count`	number	Bounces
`campaign_lead_stats`	json	Lead counts by state
`upload_count`	number	Leads submitted in the request
`success`	boolean	Whether the action succeeded
`items`	array	Records returned by Smartlead
`rows`	array	Rows returned by Smartlead
`lists`	array	Lead lists
`summary`	array	Webhook delivery summary rows
`csv`	string	Exported leads as CSV
`row_count`	number	Rows in the exported CSV
`has_more`	boolean	Whether more rows are available
`list_name`	string	Lead list name
`positive_reply_count`	number	Replies categorized as positive
`offset`	number	Pagination offset used
`limit`	number	Pagination limit used
`total_count`	number	Total records matching the request
`from`	string	Start of the reported window
`to`	string	End of the reported window
`start_date`	string	Start of the reported range
`end_date`	string	End of the reported range
`skipped_count`	number	Emails skipped
`failed_count`	number	Failed sends
`stopped_count`	number	Stopped leads
`unsubscribed_count`	number	Unsubscribes
`unique_sent_count`	number	Unique leads emailed
`unique_open_count`	number	Unique opens
`unique_click_count`	number	Unique clicks
`block_count`	number	Blocked sends, or leads skipped by the block list
`drafted_count`	number	Drafted emails
`sequence_count`	number	Sequence steps in the campaign
`duplicate_count`	number	Duplicate leads skipped on import
`invalid_email_count`	number	Leads skipped for an invalid email
`invalid_emails`	array	Emails rejected as invalid
`already_added_to_campaign`	number	Leads already in the campaign
`unsubscribed_leads`	array	Leads skipped because they unsubscribed
`lead_import_stopped_count`	number	Leads whose import was stopped
`is_lead_limit_exhausted`	boolean	Whether the plan lead limit was hit
`is_last_sequence`	boolean	Whether the lead was on the final step
`next_sequence_id`	number	ID of the next sequence step
`next_sequence_delay_in_days`	number	Days before the next step
`first_name`	string	Lead first name
`last_name`	string	Lead last name
`phone_number`	string	Lead phone number
`company_name`	string	Lead company name
`website`	string	Lead website
`location`	string	Lead location
`linkedin_profile`	string	Lead LinkedIn profile URL
`company_url`	string	Lead company URL
`custom_fields`	json	Lead custom fields
`is_unsubscribed`	boolean	Whether the lead is unsubscribed
`lead_campaign_data`	array	Campaigns the lead belongs to
`created_at`	string	Creation timestamp
`updated_at`	string	Last update timestamp
`leads_count`	number	Leads in the list
`active_leads_count`	number	Active leads in the list
`track_settings`	array	Disabled tracking settings
`scheduler_cron_value`	json	Campaign sending schedule
`accounts`	array	Sending email accounts, excluding their stored mailbox credentials
`user_id`	number	Owning Smartlead user ID
`min_time_btwn_emails`	number	Minimum minutes between emails
`max_leads_per_day`	number	Maximum new leads per day
`stop_lead_settings`	string	Activity that stops a lead sequence
`schedule_start_time`	string	Scheduled start time
`enable_ai_esp_matching`	boolean	Whether AI ESP matching is enabled
`send_as_plain_text`	boolean	Whether emails send as plain text
`follow_up_percentage`	number	Follow-up percentage
`unsubscribe_text`	string	Unsubscribe text
`parent_campaign_id`	number	Parent campaign ID
`client_id`	number	Client ID for agency accounts
`client_name`	string	Client name
`client_email`	string	Client email
`client_company_name`	string	Client company name
`tags`	array	Tags on the record
`email_campaign_id`	number	Campaign the webhook belongs to

Smartlead Save Campaign Sequences

Replaces the email sequence for a Smartlead campaign. Send every step in one call — steps omitted from the request are removed. An empty subject makes a step reply in the previous thread.

Input

Parameter	Type	Required	Description
`sequences`	array	Yes	Ordered sequence steps. Each entry accepts seq_number, delay_in_days, subject, and email_body (HTML). Personalize with {{first_name}} or {{company_name}}.

Output

Parameter	Type	Description
`campaigns`	array	List of campaigns
`leads`	array	List of leads
`sequences`	array	Email sequence steps
`categories`	array	Lead categories
`webhooks`	array	Campaign webhooks
`stats`	array	Per-email statistics rows
`history`	array	Lead message history
`count`	number	Number of records returned
`total_leads`	number	Total leads in the campaign, or leads newly added when importing
`total_stats`	number	Total statistics rows matching the filters
`id`	number	Record ID
`name`	string	Record name
`status`	string	Campaign status
`email`	string	Lead email address
`webhook_url`	string	Webhook destination URL
`event_types`	array	Webhook event types
`sent_count`	number	Emails sent
`open_count`	number	Email opens
`click_count`	number	Link clicks
`reply_count`	number	Replies
`bounce_count`	number	Bounces
`campaign_lead_stats`	json	Lead counts by state
`upload_count`	number	Leads submitted in the request
`success`	boolean	Whether the action succeeded
`items`	array	Records returned by Smartlead
`rows`	array	Rows returned by Smartlead
`lists`	array	Lead lists
`summary`	array	Webhook delivery summary rows
`csv`	string	Exported leads as CSV
`row_count`	number	Rows in the exported CSV
`has_more`	boolean	Whether more rows are available
`list_name`	string	Lead list name
`positive_reply_count`	number	Replies categorized as positive
`offset`	number	Pagination offset used
`limit`	number	Pagination limit used
`total_count`	number	Total records matching the request
`from`	string	Start of the reported window
`to`	string	End of the reported window
`start_date`	string	Start of the reported range
`end_date`	string	End of the reported range
`skipped_count`	number	Emails skipped
`failed_count`	number	Failed sends
`stopped_count`	number	Stopped leads
`unsubscribed_count`	number	Unsubscribes
`unique_sent_count`	number	Unique leads emailed
`unique_open_count`	number	Unique opens
`unique_click_count`	number	Unique clicks
`block_count`	number	Blocked sends, or leads skipped by the block list
`drafted_count`	number	Drafted emails
`sequence_count`	number	Sequence steps in the campaign
`duplicate_count`	number	Duplicate leads skipped on import
`invalid_email_count`	number	Leads skipped for an invalid email
`invalid_emails`	array	Emails rejected as invalid
`already_added_to_campaign`	number	Leads already in the campaign
`unsubscribed_leads`	array	Leads skipped because they unsubscribed
`lead_import_stopped_count`	number	Leads whose import was stopped
`is_lead_limit_exhausted`	boolean	Whether the plan lead limit was hit
`is_last_sequence`	boolean	Whether the lead was on the final step
`next_sequence_id`	number	ID of the next sequence step
`next_sequence_delay_in_days`	number	Days before the next step
`first_name`	string	Lead first name
`last_name`	string	Lead last name
`phone_number`	string	Lead phone number
`company_name`	string	Lead company name
`website`	string	Lead website
`location`	string	Lead location
`linkedin_profile`	string	Lead LinkedIn profile URL
`company_url`	string	Lead company URL
`custom_fields`	json	Lead custom fields
`is_unsubscribed`	boolean	Whether the lead is unsubscribed
`lead_campaign_data`	array	Campaigns the lead belongs to
`created_at`	string	Creation timestamp
`updated_at`	string	Last update timestamp
`leads_count`	number	Leads in the list
`active_leads_count`	number	Active leads in the list
`track_settings`	array	Disabled tracking settings
`scheduler_cron_value`	json	Campaign sending schedule
`accounts`	array	Sending email accounts, excluding their stored mailbox credentials
`user_id`	number	Owning Smartlead user ID
`min_time_btwn_emails`	number	Minimum minutes between emails
`max_leads_per_day`	number	Maximum new leads per day
`stop_lead_settings`	string	Activity that stops a lead sequence
`schedule_start_time`	string	Scheduled start time
`enable_ai_esp_matching`	boolean	Whether AI ESP matching is enabled
`send_as_plain_text`	boolean	Whether emails send as plain text
`follow_up_percentage`	number	Follow-up percentage
`unsubscribe_text`	string	Unsubscribe text
`parent_campaign_id`	number	Parent campaign ID
`client_id`	number	Client ID for agency accounts
`client_name`	string	Client name
`client_email`	string	Client email
`client_company_name`	string	Client company name
`tags`	array	Tags on the record
`email_campaign_id`	number	Campaign the webhook belongs to

Smartlead Get Campaign Statistics

Retrieves per-email statistics rows for a Smartlead campaign, filterable by sequence step, engagement status, and sent-time range.

Input

Parameter	Type	Required	Description
`offset`	number	No	Pagination offset (default 0)
`limit`	number	No	Rows to return (default 100)
`emailSequenceNumber`	number	No	Only return rows for this sequence step
`emailStatus`	string	No	Only return rows with this engagement status: opened, clicked, replied, unsubscribed, bounced
`sentTimeStartDate`	string	No	Only return rows sent on or after this date (YYYY-MM-DD)
`sentTimeEndDate`	string	No	Only return rows sent on or before this date (YYYY-MM-DD)

Output

Parameter	Type	Description
`campaigns`	array	List of campaigns
`leads`	array	List of leads
`sequences`	array	Email sequence steps
`categories`	array	Lead categories
`webhooks`	array	Campaign webhooks
`stats`	array	Per-email statistics rows
`history`	array	Lead message history
`count`	number	Number of records returned
`total_leads`	number	Total leads in the campaign, or leads newly added when importing
`total_stats`	number	Total statistics rows matching the filters
`id`	number	Record ID
`name`	string	Record name
`status`	string	Campaign status
`email`	string	Lead email address
`webhook_url`	string	Webhook destination URL
`event_types`	array	Webhook event types
`sent_count`	number	Emails sent
`open_count`	number	Email opens
`click_count`	number	Link clicks
`reply_count`	number	Replies
`bounce_count`	number	Bounces
`campaign_lead_stats`	json	Lead counts by state
`upload_count`	number	Leads submitted in the request
`success`	boolean	Whether the action succeeded
`items`	array	Records returned by Smartlead
`rows`	array	Rows returned by Smartlead
`lists`	array	Lead lists
`summary`	array	Webhook delivery summary rows
`csv`	string	Exported leads as CSV
`row_count`	number	Rows in the exported CSV
`has_more`	boolean	Whether more rows are available
`list_name`	string	Lead list name
`positive_reply_count`	number	Replies categorized as positive
`offset`	number	Pagination offset used
`limit`	number	Pagination limit used
`total_count`	number	Total records matching the request
`from`	string	Start of the reported window
`to`	string	End of the reported window
`start_date`	string	Start of the reported range
`end_date`	string	End of the reported range
`skipped_count`	number	Emails skipped
`failed_count`	number	Failed sends
`stopped_count`	number	Stopped leads
`unsubscribed_count`	number	Unsubscribes
`unique_sent_count`	number	Unique leads emailed
`unique_open_count`	number	Unique opens
`unique_click_count`	number	Unique clicks
`block_count`	number	Blocked sends, or leads skipped by the block list
`drafted_count`	number	Drafted emails
`sequence_count`	number	Sequence steps in the campaign
`duplicate_count`	number	Duplicate leads skipped on import
`invalid_email_count`	number	Leads skipped for an invalid email
`invalid_emails`	array	Emails rejected as invalid
`already_added_to_campaign`	number	Leads already in the campaign
`unsubscribed_leads`	array	Leads skipped because they unsubscribed
`lead_import_stopped_count`	number	Leads whose import was stopped
`is_lead_limit_exhausted`	boolean	Whether the plan lead limit was hit
`is_last_sequence`	boolean	Whether the lead was on the final step
`next_sequence_id`	number	ID of the next sequence step
`next_sequence_delay_in_days`	number	Days before the next step
`first_name`	string	Lead first name
`last_name`	string	Lead last name
`phone_number`	string	Lead phone number
`company_name`	string	Lead company name
`website`	string	Lead website
`location`	string	Lead location
`linkedin_profile`	string	Lead LinkedIn profile URL
`company_url`	string	Lead company URL
`custom_fields`	json	Lead custom fields
`is_unsubscribed`	boolean	Whether the lead is unsubscribed
`lead_campaign_data`	array	Campaigns the lead belongs to
`created_at`	string	Creation timestamp
`updated_at`	string	Last update timestamp
`leads_count`	number	Leads in the list
`active_leads_count`	number	Active leads in the list
`track_settings`	array	Disabled tracking settings
`scheduler_cron_value`	json	Campaign sending schedule
`accounts`	array	Sending email accounts, excluding their stored mailbox credentials
`user_id`	number	Owning Smartlead user ID
`min_time_btwn_emails`	number	Minimum minutes between emails
`max_leads_per_day`	number	Maximum new leads per day
`stop_lead_settings`	string	Activity that stops a lead sequence
`schedule_start_time`	string	Scheduled start time
`enable_ai_esp_matching`	boolean	Whether AI ESP matching is enabled
`send_as_plain_text`	boolean	Whether emails send as plain text
`follow_up_percentage`	number	Follow-up percentage
`unsubscribe_text`	string	Unsubscribe text
`parent_campaign_id`	number	Parent campaign ID
`client_id`	number	Client ID for agency accounts
`client_name`	string	Client name
`client_email`	string	Client email
`client_company_name`	string	Client company name
`tags`	array	Tags on the record
`email_campaign_id`	number	Campaign the webhook belongs to

Smartlead Add Leads to Campaign

Adds leads to a Smartlead campaign, up to 400 per call. Returns per-reason counts for leads that were skipped as duplicates, blocked, bounced, or invalid.

Input

Parameter	Type	Required	Description
`leads`	array	Yes	Leads to add (max 400). Each entry requires email and accepts first_name, last_name, phone_number, company_name, website, location, linkedin_profile, company_url, and custom_fields.
`ignoreGlobalBlockList`	boolean	No	Add leads even if they are on the global block list
`ignoreUnsubscribeList`	boolean	No	Add leads even if they previously unsubscribed
`ignoreDuplicateLeadsInOtherCampaign`	boolean	No	Add leads even if they already exist in another campaign
`ignoreCommunityBounceList`	boolean	No	Add leads even if they are on the community bounce list

Output

Parameter	Type	Description
`campaigns`	array	List of campaigns
`leads`	array	List of leads
`sequences`	array	Email sequence steps
`categories`	array	Lead categories
`webhooks`	array	Campaign webhooks
`stats`	array	Per-email statistics rows
`history`	array	Lead message history
`count`	number	Number of records returned
`total_leads`	number	Total leads in the campaign, or leads newly added when importing
`total_stats`	number	Total statistics rows matching the filters
`id`	number	Record ID
`name`	string	Record name
`status`	string	Campaign status
`email`	string	Lead email address
`webhook_url`	string	Webhook destination URL
`event_types`	array	Webhook event types
`sent_count`	number	Emails sent
`open_count`	number	Email opens
`click_count`	number	Link clicks
`reply_count`	number	Replies
`bounce_count`	number	Bounces
`campaign_lead_stats`	json	Lead counts by state
`upload_count`	number	Leads submitted in the request
`success`	boolean	Whether the action succeeded
`items`	array	Records returned by Smartlead
`rows`	array	Rows returned by Smartlead
`lists`	array	Lead lists
`summary`	array	Webhook delivery summary rows
`csv`	string	Exported leads as CSV
`row_count`	number	Rows in the exported CSV
`has_more`	boolean	Whether more rows are available
`list_name`	string	Lead list name
`positive_reply_count`	number	Replies categorized as positive
`offset`	number	Pagination offset used
`limit`	number	Pagination limit used
`total_count`	number	Total records matching the request
`from`	string	Start of the reported window
`to`	string	End of the reported window
`start_date`	string	Start of the reported range
`end_date`	string	End of the reported range
`skipped_count`	number	Emails skipped
`failed_count`	number	Failed sends
`stopped_count`	number	Stopped leads
`unsubscribed_count`	number	Unsubscribes
`unique_sent_count`	number	Unique leads emailed
`unique_open_count`	number	Unique opens
`unique_click_count`	number	Unique clicks
`block_count`	number	Blocked sends, or leads skipped by the block list
`drafted_count`	number	Drafted emails
`sequence_count`	number	Sequence steps in the campaign
`duplicate_count`	number	Duplicate leads skipped on import
`invalid_email_count`	number	Leads skipped for an invalid email
`invalid_emails`	array	Emails rejected as invalid
`already_added_to_campaign`	number	Leads already in the campaign
`unsubscribed_leads`	array	Leads skipped because they unsubscribed
`lead_import_stopped_count`	number	Leads whose import was stopped
`is_lead_limit_exhausted`	boolean	Whether the plan lead limit was hit
`is_last_sequence`	boolean	Whether the lead was on the final step
`next_sequence_id`	number	ID of the next sequence step
`next_sequence_delay_in_days`	number	Days before the next step
`first_name`	string	Lead first name
`last_name`	string	Lead last name
`phone_number`	string	Lead phone number
`company_name`	string	Lead company name
`website`	string	Lead website
`location`	string	Lead location
`linkedin_profile`	string	Lead LinkedIn profile URL
`company_url`	string	Lead company URL
`custom_fields`	json	Lead custom fields
`is_unsubscribed`	boolean	Whether the lead is unsubscribed
`lead_campaign_data`	array	Campaigns the lead belongs to
`created_at`	string	Creation timestamp
`updated_at`	string	Last update timestamp
`leads_count`	number	Leads in the list
`active_leads_count`	number	Active leads in the list
`track_settings`	array	Disabled tracking settings
`scheduler_cron_value`	json	Campaign sending schedule
`accounts`	array	Sending email accounts, excluding their stored mailbox credentials
`user_id`	number	Owning Smartlead user ID
`min_time_btwn_emails`	number	Minimum minutes between emails
`max_leads_per_day`	number	Maximum new leads per day
`stop_lead_settings`	string	Activity that stops a lead sequence
`schedule_start_time`	string	Scheduled start time
`enable_ai_esp_matching`	boolean	Whether AI ESP matching is enabled
`send_as_plain_text`	boolean	Whether emails send as plain text
`follow_up_percentage`	number	Follow-up percentage
`unsubscribe_text`	string	Unsubscribe text
`parent_campaign_id`	number	Parent campaign ID
`client_id`	number	Client ID for agency accounts
`client_name`	string	Client name
`client_email`	string	Client email
`client_company_name`	string	Client company name
`tags`	array	Tags on the record
`email_campaign_id`	number	Campaign the webhook belongs to

Smartlead List Campaign Leads

Retrieves the leads in a Smartlead campaign with their per-campaign status.

Input

Parameter	Type	Required	Description
`offset`	number	No	Pagination offset (default 0)
`limit`	number	No	Leads to return per page (default 100)

Output

Parameter	Type	Description
`campaigns`	array	List of campaigns
`leads`	array	List of leads
`sequences`	array	Email sequence steps
`categories`	array	Lead categories
`webhooks`	array	Campaign webhooks
`stats`	array	Per-email statistics rows
`history`	array	Lead message history
`count`	number	Number of records returned
`total_leads`	number	Total leads in the campaign, or leads newly added when importing
`total_stats`	number	Total statistics rows matching the filters
`id`	number	Record ID
`name`	string	Record name
`status`	string	Campaign status
`email`	string	Lead email address
`webhook_url`	string	Webhook destination URL
`event_types`	array	Webhook event types
`sent_count`	number	Emails sent
`open_count`	number	Email opens
`click_count`	number	Link clicks
`reply_count`	number	Replies
`bounce_count`	number	Bounces
`campaign_lead_stats`	json	Lead counts by state
`upload_count`	number	Leads submitted in the request
`success`	boolean	Whether the action succeeded
`items`	array	Records returned by Smartlead
`rows`	array	Rows returned by Smartlead
`lists`	array	Lead lists
`summary`	array	Webhook delivery summary rows
`csv`	string	Exported leads as CSV
`row_count`	number	Rows in the exported CSV
`has_more`	boolean	Whether more rows are available
`list_name`	string	Lead list name
`positive_reply_count`	number	Replies categorized as positive
`offset`	number	Pagination offset used
`limit`	number	Pagination limit used
`total_count`	number	Total records matching the request
`from`	string	Start of the reported window
`to`	string	End of the reported window
`start_date`	string	Start of the reported range
`end_date`	string	End of the reported range
`skipped_count`	number	Emails skipped
`failed_count`	number	Failed sends
`stopped_count`	number	Stopped leads
`unsubscribed_count`	number	Unsubscribes
`unique_sent_count`	number	Unique leads emailed
`unique_open_count`	number	Unique opens
`unique_click_count`	number	Unique clicks
`block_count`	number	Blocked sends, or leads skipped by the block list
`drafted_count`	number	Drafted emails
`sequence_count`	number	Sequence steps in the campaign
`duplicate_count`	number	Duplicate leads skipped on import
`invalid_email_count`	number	Leads skipped for an invalid email
`invalid_emails`	array	Emails rejected as invalid
`already_added_to_campaign`	number	Leads already in the campaign
`unsubscribed_leads`	array	Leads skipped because they unsubscribed
`lead_import_stopped_count`	number	Leads whose import was stopped
`is_lead_limit_exhausted`	boolean	Whether the plan lead limit was hit
`is_last_sequence`	boolean	Whether the lead was on the final step
`next_sequence_id`	number	ID of the next sequence step
`next_sequence_delay_in_days`	number	Days before the next step
`first_name`	string	Lead first name
`last_name`	string	Lead last name
`phone_number`	string	Lead phone number
`company_name`	string	Lead company name
`website`	string	Lead website
`location`	string	Lead location
`linkedin_profile`	string	Lead LinkedIn profile URL
`company_url`	string	Lead company URL
`custom_fields`	json	Lead custom fields
`is_unsubscribed`	boolean	Whether the lead is unsubscribed
`lead_campaign_data`	array	Campaigns the lead belongs to
`created_at`	string	Creation timestamp
`updated_at`	string	Last update timestamp
`leads_count`	number	Leads in the list
`active_leads_count`	number	Active leads in the list
`track_settings`	array	Disabled tracking settings
`scheduler_cron_value`	json	Campaign sending schedule
`accounts`	array	Sending email accounts, excluding their stored mailbox credentials
`user_id`	number	Owning Smartlead user ID
`min_time_btwn_emails`	number	Minimum minutes between emails
`max_leads_per_day`	number	Maximum new leads per day
`stop_lead_settings`	string	Activity that stops a lead sequence
`schedule_start_time`	string	Scheduled start time
`enable_ai_esp_matching`	boolean	Whether AI ESP matching is enabled
`send_as_plain_text`	boolean	Whether emails send as plain text
`follow_up_percentage`	number	Follow-up percentage
`unsubscribe_text`	string	Unsubscribe text
`parent_campaign_id`	number	Parent campaign ID
`client_id`	number	Client ID for agency accounts
`client_name`	string	Client name
`client_email`	string	Client email
`client_company_name`	string	Client company name
`tags`	array	Tags on the record
`email_campaign_id`	number	Campaign the webhook belongs to

Smartlead Get Lead by Email

Looks up a Smartlead lead by email address and returns the lead record plus every campaign it belongs to.

Input

Parameter	Type	Required	Description
`email`	string	Yes	Lead email address to look up

Output

Parameter	Type	Description
`campaigns`	array	List of campaigns
`leads`	array	List of leads
`sequences`	array	Email sequence steps
`categories`	array	Lead categories
`webhooks`	array	Campaign webhooks
`stats`	array	Per-email statistics rows
`history`	array	Lead message history
`count`	number	Number of records returned
`total_leads`	number	Total leads in the campaign, or leads newly added when importing
`total_stats`	number	Total statistics rows matching the filters
`id`	number	Record ID
`name`	string	Record name
`status`	string	Campaign status
`email`	string	Lead email address
`webhook_url`	string	Webhook destination URL
`event_types`	array	Webhook event types
`sent_count`	number	Emails sent
`open_count`	number	Email opens
`click_count`	number	Link clicks
`reply_count`	number	Replies
`bounce_count`	number	Bounces
`campaign_lead_stats`	json	Lead counts by state
`upload_count`	number	Leads submitted in the request
`success`	boolean	Whether the action succeeded
`items`	array	Records returned by Smartlead
`rows`	array	Rows returned by Smartlead
`lists`	array	Lead lists
`summary`	array	Webhook delivery summary rows
`csv`	string	Exported leads as CSV
`row_count`	number	Rows in the exported CSV
`has_more`	boolean	Whether more rows are available
`list_name`	string	Lead list name
`positive_reply_count`	number	Replies categorized as positive
`offset`	number	Pagination offset used
`limit`	number	Pagination limit used
`total_count`	number	Total records matching the request
`from`	string	Start of the reported window
`to`	string	End of the reported window
`start_date`	string	Start of the reported range
`end_date`	string	End of the reported range
`skipped_count`	number	Emails skipped
`failed_count`	number	Failed sends
`stopped_count`	number	Stopped leads
`unsubscribed_count`	number	Unsubscribes
`unique_sent_count`	number	Unique leads emailed
`unique_open_count`	number	Unique opens
`unique_click_count`	number	Unique clicks
`block_count`	number	Blocked sends, or leads skipped by the block list
`drafted_count`	number	Drafted emails
`sequence_count`	number	Sequence steps in the campaign
`duplicate_count`	number	Duplicate leads skipped on import
`invalid_email_count`	number	Leads skipped for an invalid email
`invalid_emails`	array	Emails rejected as invalid
`already_added_to_campaign`	number	Leads already in the campaign
`unsubscribed_leads`	array	Leads skipped because they unsubscribed
`lead_import_stopped_count`	number	Leads whose import was stopped
`is_lead_limit_exhausted`	boolean	Whether the plan lead limit was hit
`is_last_sequence`	boolean	Whether the lead was on the final step
`next_sequence_id`	number	ID of the next sequence step
`next_sequence_delay_in_days`	number	Days before the next step
`first_name`	string	Lead first name
`last_name`	string	Lead last name
`phone_number`	string	Lead phone number
`company_name`	string	Lead company name
`website`	string	Lead website
`location`	string	Lead location
`linkedin_profile`	string	Lead LinkedIn profile URL
`company_url`	string	Lead company URL
`custom_fields`	json	Lead custom fields
`is_unsubscribed`	boolean	Whether the lead is unsubscribed
`lead_campaign_data`	array	Campaigns the lead belongs to
`created_at`	string	Creation timestamp
`updated_at`	string	Last update timestamp
`leads_count`	number	Leads in the list
`active_leads_count`	number	Active leads in the list
`track_settings`	array	Disabled tracking settings
`scheduler_cron_value`	json	Campaign sending schedule
`accounts`	array	Sending email accounts, excluding their stored mailbox credentials
`user_id`	number	Owning Smartlead user ID
`min_time_btwn_emails`	number	Minimum minutes between emails
`max_leads_per_day`	number	Maximum new leads per day
`stop_lead_settings`	string	Activity that stops a lead sequence
`schedule_start_time`	string	Scheduled start time
`enable_ai_esp_matching`	boolean	Whether AI ESP matching is enabled
`send_as_plain_text`	boolean	Whether emails send as plain text
`follow_up_percentage`	number	Follow-up percentage
`unsubscribe_text`	string	Unsubscribe text
`parent_campaign_id`	number	Parent campaign ID
`client_id`	number	Client ID for agency accounts
`client_name`	string	Client name
`client_email`	string	Client email
`client_company_name`	string	Client company name
`tags`	array	Tags on the record
`email_campaign_id`	number	Campaign the webhook belongs to

Smartlead Update Lead

Updates a lead in a Smartlead campaign. Smartlead requires the email field even when it is unchanged, and lead edits apply across every campaign the lead belongs to.

Input

Parameter	Type	Required	Description
`email`	string	Yes	Lead email address — required by Smartlead even when unchanged
`firstName`	string	No	Lead first name
`lastName`	string	No	Lead last name
`phoneNumber`	string	No	Lead phone number
`companyName`	string	No	Lead company name
`website`	string	No	Lead website
`location`	string	No	Lead location
`linkedinProfile`	string	No	Lead LinkedIn profile URL
`companyUrl`	string	No	Lead company URL
`customFields`	object	No	Custom field values keyed by field name (max 200 keys)

Output

Parameter	Type	Description
`campaigns`	array	List of campaigns
`leads`	array	List of leads
`sequences`	array	Email sequence steps
`categories`	array	Lead categories
`webhooks`	array	Campaign webhooks
`stats`	array	Per-email statistics rows
`history`	array	Lead message history
`count`	number	Number of records returned
`total_leads`	number	Total leads in the campaign, or leads newly added when importing
`total_stats`	number	Total statistics rows matching the filters
`id`	number	Record ID
`name`	string	Record name
`status`	string	Campaign status
`email`	string	Lead email address
`webhook_url`	string	Webhook destination URL
`event_types`	array	Webhook event types
`sent_count`	number	Emails sent
`open_count`	number	Email opens
`click_count`	number	Link clicks
`reply_count`	number	Replies
`bounce_count`	number	Bounces
`campaign_lead_stats`	json	Lead counts by state
`upload_count`	number	Leads submitted in the request
`success`	boolean	Whether the action succeeded
`items`	array	Records returned by Smartlead
`rows`	array	Rows returned by Smartlead
`lists`	array	Lead lists
`summary`	array	Webhook delivery summary rows
`csv`	string	Exported leads as CSV
`row_count`	number	Rows in the exported CSV
`has_more`	boolean	Whether more rows are available
`list_name`	string	Lead list name
`positive_reply_count`	number	Replies categorized as positive
`offset`	number	Pagination offset used
`limit`	number	Pagination limit used
`total_count`	number	Total records matching the request
`from`	string	Start of the reported window
`to`	string	End of the reported window
`start_date`	string	Start of the reported range
`end_date`	string	End of the reported range
`skipped_count`	number	Emails skipped
`failed_count`	number	Failed sends
`stopped_count`	number	Stopped leads
`unsubscribed_count`	number	Unsubscribes
`unique_sent_count`	number	Unique leads emailed
`unique_open_count`	number	Unique opens
`unique_click_count`	number	Unique clicks
`block_count`	number	Blocked sends, or leads skipped by the block list
`drafted_count`	number	Drafted emails
`sequence_count`	number	Sequence steps in the campaign
`duplicate_count`	number	Duplicate leads skipped on import
`invalid_email_count`	number	Leads skipped for an invalid email
`invalid_emails`	array	Emails rejected as invalid
`already_added_to_campaign`	number	Leads already in the campaign
`unsubscribed_leads`	array	Leads skipped because they unsubscribed
`lead_import_stopped_count`	number	Leads whose import was stopped
`is_lead_limit_exhausted`	boolean	Whether the plan lead limit was hit
`is_last_sequence`	boolean	Whether the lead was on the final step
`next_sequence_id`	number	ID of the next sequence step
`next_sequence_delay_in_days`	number	Days before the next step
`first_name`	string	Lead first name
`last_name`	string	Lead last name
`phone_number`	string	Lead phone number
`company_name`	string	Lead company name
`website`	string	Lead website
`location`	string	Lead location
`linkedin_profile`	string	Lead LinkedIn profile URL
`company_url`	string	Lead company URL
`custom_fields`	json	Lead custom fields
`is_unsubscribed`	boolean	Whether the lead is unsubscribed
`lead_campaign_data`	array	Campaigns the lead belongs to
`created_at`	string	Creation timestamp
`updated_at`	string	Last update timestamp
`leads_count`	number	Leads in the list
`active_leads_count`	number	Active leads in the list
`track_settings`	array	Disabled tracking settings
`scheduler_cron_value`	json	Campaign sending schedule
`accounts`	array	Sending email accounts, excluding their stored mailbox credentials
`user_id`	number	Owning Smartlead user ID
`min_time_btwn_emails`	number	Minimum minutes between emails
`max_leads_per_day`	number	Maximum new leads per day
`stop_lead_settings`	string	Activity that stops a lead sequence
`schedule_start_time`	string	Scheduled start time
`enable_ai_esp_matching`	boolean	Whether AI ESP matching is enabled
`send_as_plain_text`	boolean	Whether emails send as plain text
`follow_up_percentage`	number	Follow-up percentage
`unsubscribe_text`	string	Unsubscribe text
`parent_campaign_id`	number	Parent campaign ID
`client_id`	number	Client ID for agency accounts
`client_name`	string	Client name
`client_email`	string	Client email
`client_company_name`	string	Client company name
`tags`	array	Tags on the record
`email_campaign_id`	number	Campaign the webhook belongs to

Smartlead Update Lead Category

Sets the category of a lead in a Smartlead campaign, such as Interested or Not Interested. Use List Lead Categories to resolve a category ID.

Input

Parameter	Type	Required	Description
`categoryId`	number	Yes	Lead category ID to apply
`pauseLead`	boolean	No	Also pause the lead sequence when applying the category

Output

Parameter	Type	Description
`campaigns`	array	List of campaigns
`leads`	array	List of leads
`sequences`	array	Email sequence steps
`categories`	array	Lead categories
`webhooks`	array	Campaign webhooks
`stats`	array	Per-email statistics rows
`history`	array	Lead message history
`count`	number	Number of records returned
`total_leads`	number	Total leads in the campaign, or leads newly added when importing
`total_stats`	number	Total statistics rows matching the filters
`id`	number	Record ID
`name`	string	Record name
`status`	string	Campaign status
`email`	string	Lead email address
`webhook_url`	string	Webhook destination URL
`event_types`	array	Webhook event types
`sent_count`	number	Emails sent
`open_count`	number	Email opens
`click_count`	number	Link clicks
`reply_count`	number	Replies
`bounce_count`	number	Bounces
`campaign_lead_stats`	json	Lead counts by state
`upload_count`	number	Leads submitted in the request
`success`	boolean	Whether the action succeeded
`items`	array	Records returned by Smartlead
`rows`	array	Rows returned by Smartlead
`lists`	array	Lead lists
`summary`	array	Webhook delivery summary rows
`csv`	string	Exported leads as CSV
`row_count`	number	Rows in the exported CSV
`has_more`	boolean	Whether more rows are available
`list_name`	string	Lead list name
`positive_reply_count`	number	Replies categorized as positive
`offset`	number	Pagination offset used
`limit`	number	Pagination limit used
`total_count`	number	Total records matching the request
`from`	string	Start of the reported window
`to`	string	End of the reported window
`start_date`	string	Start of the reported range
`end_date`	string	End of the reported range
`skipped_count`	number	Emails skipped
`failed_count`	number	Failed sends
`stopped_count`	number	Stopped leads
`unsubscribed_count`	number	Unsubscribes
`unique_sent_count`	number	Unique leads emailed
`unique_open_count`	number	Unique opens
`unique_click_count`	number	Unique clicks
`block_count`	number	Blocked sends, or leads skipped by the block list
`drafted_count`	number	Drafted emails
`sequence_count`	number	Sequence steps in the campaign
`duplicate_count`	number	Duplicate leads skipped on import
`invalid_email_count`	number	Leads skipped for an invalid email
`invalid_emails`	array	Emails rejected as invalid
`already_added_to_campaign`	number	Leads already in the campaign
`unsubscribed_leads`	array	Leads skipped because they unsubscribed
`lead_import_stopped_count`	number	Leads whose import was stopped
`is_lead_limit_exhausted`	boolean	Whether the plan lead limit was hit
`is_last_sequence`	boolean	Whether the lead was on the final step
`next_sequence_id`	number	ID of the next sequence step
`next_sequence_delay_in_days`	number	Days before the next step
`first_name`	string	Lead first name
`last_name`	string	Lead last name
`phone_number`	string	Lead phone number
`company_name`	string	Lead company name
`website`	string	Lead website
`location`	string	Lead location
`linkedin_profile`	string	Lead LinkedIn profile URL
`company_url`	string	Lead company URL
`custom_fields`	json	Lead custom fields
`is_unsubscribed`	boolean	Whether the lead is unsubscribed
`lead_campaign_data`	array	Campaigns the lead belongs to
`created_at`	string	Creation timestamp
`updated_at`	string	Last update timestamp
`leads_count`	number	Leads in the list
`active_leads_count`	number	Active leads in the list
`track_settings`	array	Disabled tracking settings
`scheduler_cron_value`	json	Campaign sending schedule
`accounts`	array	Sending email accounts, excluding their stored mailbox credentials
`user_id`	number	Owning Smartlead user ID
`min_time_btwn_emails`	number	Minimum minutes between emails
`max_leads_per_day`	number	Maximum new leads per day
`stop_lead_settings`	string	Activity that stops a lead sequence
`schedule_start_time`	string	Scheduled start time
`enable_ai_esp_matching`	boolean	Whether AI ESP matching is enabled
`send_as_plain_text`	boolean	Whether emails send as plain text
`follow_up_percentage`	number	Follow-up percentage
`unsubscribe_text`	string	Unsubscribe text
`parent_campaign_id`	number	Parent campaign ID
`client_id`	number	Client ID for agency accounts
`client_name`	string	Client name
`client_email`	string	Client email
`client_company_name`	string	Client company name
`tags`	array	Tags on the record
`email_campaign_id`	number	Campaign the webhook belongs to

Smartlead Pause Lead

Pauses a lead in a Smartlead campaign so it stops receiving sequence emails.

Input

Parameter	Type	Required	Description

Output

Parameter	Type	Description
`campaigns`	array	List of campaigns
`leads`	array	List of leads
`sequences`	array	Email sequence steps
`categories`	array	Lead categories
`webhooks`	array	Campaign webhooks
`stats`	array	Per-email statistics rows
`history`	array	Lead message history
`count`	number	Number of records returned
`total_leads`	number	Total leads in the campaign, or leads newly added when importing
`total_stats`	number	Total statistics rows matching the filters
`id`	number	Record ID
`name`	string	Record name
`status`	string	Campaign status
`email`	string	Lead email address
`webhook_url`	string	Webhook destination URL
`event_types`	array	Webhook event types
`sent_count`	number	Emails sent
`open_count`	number	Email opens
`click_count`	number	Link clicks
`reply_count`	number	Replies
`bounce_count`	number	Bounces
`campaign_lead_stats`	json	Lead counts by state
`upload_count`	number	Leads submitted in the request
`success`	boolean	Whether the action succeeded
`items`	array	Records returned by Smartlead
`rows`	array	Rows returned by Smartlead
`lists`	array	Lead lists
`summary`	array	Webhook delivery summary rows
`csv`	string	Exported leads as CSV
`row_count`	number	Rows in the exported CSV
`has_more`	boolean	Whether more rows are available
`list_name`	string	Lead list name
`positive_reply_count`	number	Replies categorized as positive
`offset`	number	Pagination offset used
`limit`	number	Pagination limit used
`total_count`	number	Total records matching the request
`from`	string	Start of the reported window
`to`	string	End of the reported window
`start_date`	string	Start of the reported range
`end_date`	string	End of the reported range
`skipped_count`	number	Emails skipped
`failed_count`	number	Failed sends
`stopped_count`	number	Stopped leads
`unsubscribed_count`	number	Unsubscribes
`unique_sent_count`	number	Unique leads emailed
`unique_open_count`	number	Unique opens
`unique_click_count`	number	Unique clicks
`block_count`	number	Blocked sends, or leads skipped by the block list
`drafted_count`	number	Drafted emails
`sequence_count`	number	Sequence steps in the campaign
`duplicate_count`	number	Duplicate leads skipped on import
`invalid_email_count`	number	Leads skipped for an invalid email
`invalid_emails`	array	Emails rejected as invalid
`already_added_to_campaign`	number	Leads already in the campaign
`unsubscribed_leads`	array	Leads skipped because they unsubscribed
`lead_import_stopped_count`	number	Leads whose import was stopped
`is_lead_limit_exhausted`	boolean	Whether the plan lead limit was hit
`is_last_sequence`	boolean	Whether the lead was on the final step
`next_sequence_id`	number	ID of the next sequence step
`next_sequence_delay_in_days`	number	Days before the next step
`first_name`	string	Lead first name
`last_name`	string	Lead last name
`phone_number`	string	Lead phone number
`company_name`	string	Lead company name
`website`	string	Lead website
`location`	string	Lead location
`linkedin_profile`	string	Lead LinkedIn profile URL
`company_url`	string	Lead company URL
`custom_fields`	json	Lead custom fields
`is_unsubscribed`	boolean	Whether the lead is unsubscribed
`lead_campaign_data`	array	Campaigns the lead belongs to
`created_at`	string	Creation timestamp
`updated_at`	string	Last update timestamp
`leads_count`	number	Leads in the list
`active_leads_count`	number	Active leads in the list
`track_settings`	array	Disabled tracking settings
`scheduler_cron_value`	json	Campaign sending schedule
`accounts`	array	Sending email accounts, excluding their stored mailbox credentials
`user_id`	number	Owning Smartlead user ID
`min_time_btwn_emails`	number	Minimum minutes between emails
`max_leads_per_day`	number	Maximum new leads per day
`stop_lead_settings`	string	Activity that stops a lead sequence
`schedule_start_time`	string	Scheduled start time
`enable_ai_esp_matching`	boolean	Whether AI ESP matching is enabled
`send_as_plain_text`	boolean	Whether emails send as plain text
`follow_up_percentage`	number	Follow-up percentage
`unsubscribe_text`	string	Unsubscribe text
`parent_campaign_id`	number	Parent campaign ID
`client_id`	number	Client ID for agency accounts
`client_name`	string	Client name
`client_email`	string	Client email
`client_company_name`	string	Client company name
`tags`	array	Tags on the record
`email_campaign_id`	number	Campaign the webhook belongs to

Smartlead Resume Lead

Resumes a paused lead in a Smartlead campaign, optionally after a delay.

Input

Parameter	Type	Required	Description
`resumeLeadWithDelayDays`	number	No	Days to wait before the next email; 0 resumes immediately

Output

Parameter	Type	Description
`campaigns`	array	List of campaigns
`leads`	array	List of leads
`sequences`	array	Email sequence steps
`categories`	array	Lead categories
`webhooks`	array	Campaign webhooks
`stats`	array	Per-email statistics rows
`history`	array	Lead message history
`count`	number	Number of records returned
`total_leads`	number	Total leads in the campaign, or leads newly added when importing
`total_stats`	number	Total statistics rows matching the filters
`id`	number	Record ID
`name`	string	Record name
`status`	string	Campaign status
`email`	string	Lead email address
`webhook_url`	string	Webhook destination URL
`event_types`	array	Webhook event types
`sent_count`	number	Emails sent
`open_count`	number	Email opens
`click_count`	number	Link clicks
`reply_count`	number	Replies
`bounce_count`	number	Bounces
`campaign_lead_stats`	json	Lead counts by state
`upload_count`	number	Leads submitted in the request
`success`	boolean	Whether the action succeeded
`items`	array	Records returned by Smartlead
`rows`	array	Rows returned by Smartlead
`lists`	array	Lead lists
`summary`	array	Webhook delivery summary rows
`csv`	string	Exported leads as CSV
`row_count`	number	Rows in the exported CSV
`has_more`	boolean	Whether more rows are available
`list_name`	string	Lead list name
`positive_reply_count`	number	Replies categorized as positive
`offset`	number	Pagination offset used
`limit`	number	Pagination limit used
`total_count`	number	Total records matching the request
`from`	string	Start of the reported window
`to`	string	End of the reported window
`start_date`	string	Start of the reported range
`end_date`	string	End of the reported range
`skipped_count`	number	Emails skipped
`failed_count`	number	Failed sends
`stopped_count`	number	Stopped leads
`unsubscribed_count`	number	Unsubscribes
`unique_sent_count`	number	Unique leads emailed
`unique_open_count`	number	Unique opens
`unique_click_count`	number	Unique clicks
`block_count`	number	Blocked sends, or leads skipped by the block list
`drafted_count`	number	Drafted emails
`sequence_count`	number	Sequence steps in the campaign
`duplicate_count`	number	Duplicate leads skipped on import
`invalid_email_count`	number	Leads skipped for an invalid email
`invalid_emails`	array	Emails rejected as invalid
`already_added_to_campaign`	number	Leads already in the campaign
`unsubscribed_leads`	array	Leads skipped because they unsubscribed
`lead_import_stopped_count`	number	Leads whose import was stopped
`is_lead_limit_exhausted`	boolean	Whether the plan lead limit was hit
`is_last_sequence`	boolean	Whether the lead was on the final step
`next_sequence_id`	number	ID of the next sequence step
`next_sequence_delay_in_days`	number	Days before the next step
`first_name`	string	Lead first name
`last_name`	string	Lead last name
`phone_number`	string	Lead phone number
`company_name`	string	Lead company name
`website`	string	Lead website
`location`	string	Lead location
`linkedin_profile`	string	Lead LinkedIn profile URL
`company_url`	string	Lead company URL
`custom_fields`	json	Lead custom fields
`is_unsubscribed`	boolean	Whether the lead is unsubscribed
`lead_campaign_data`	array	Campaigns the lead belongs to
`created_at`	string	Creation timestamp
`updated_at`	string	Last update timestamp
`leads_count`	number	Leads in the list
`active_leads_count`	number	Active leads in the list
`track_settings`	array	Disabled tracking settings
`scheduler_cron_value`	json	Campaign sending schedule
`accounts`	array	Sending email accounts, excluding their stored mailbox credentials
`user_id`	number	Owning Smartlead user ID
`min_time_btwn_emails`	number	Minimum minutes between emails
`max_leads_per_day`	number	Maximum new leads per day
`stop_lead_settings`	string	Activity that stops a lead sequence
`schedule_start_time`	string	Scheduled start time
`enable_ai_esp_matching`	boolean	Whether AI ESP matching is enabled
`send_as_plain_text`	boolean	Whether emails send as plain text
`follow_up_percentage`	number	Follow-up percentage
`unsubscribe_text`	string	Unsubscribe text
`parent_campaign_id`	number	Parent campaign ID
`client_id`	number	Client ID for agency accounts
`client_name`	string	Client name
`client_email`	string	Client email
`client_company_name`	string	Client company name
`tags`	array	Tags on the record
`email_campaign_id`	number	Campaign the webhook belongs to

Smartlead List Lead Categories

Retrieves the lead categories configured on the Smartlead account, with the category IDs needed to categorize a lead.

Input

Parameter	Type	Required	Description

Output

Parameter	Type	Description
`campaigns`	array	List of campaigns
`leads`	array	List of leads
`sequences`	array	Email sequence steps
`categories`	array	Lead categories
`webhooks`	array	Campaign webhooks
`stats`	array	Per-email statistics rows
`history`	array	Lead message history
`count`	number	Number of records returned
`total_leads`	number	Total leads in the campaign, or leads newly added when importing
`total_stats`	number	Total statistics rows matching the filters
`id`	number	Record ID
`name`	string	Record name
`status`	string	Campaign status
`email`	string	Lead email address
`webhook_url`	string	Webhook destination URL
`event_types`	array	Webhook event types
`sent_count`	number	Emails sent
`open_count`	number	Email opens
`click_count`	number	Link clicks
`reply_count`	number	Replies
`bounce_count`	number	Bounces
`campaign_lead_stats`	json	Lead counts by state
`upload_count`	number	Leads submitted in the request
`success`	boolean	Whether the action succeeded
`items`	array	Records returned by Smartlead
`rows`	array	Rows returned by Smartlead
`lists`	array	Lead lists
`summary`	array	Webhook delivery summary rows
`csv`	string	Exported leads as CSV
`row_count`	number	Rows in the exported CSV
`has_more`	boolean	Whether more rows are available
`list_name`	string	Lead list name
`positive_reply_count`	number	Replies categorized as positive
`offset`	number	Pagination offset used
`limit`	number	Pagination limit used
`total_count`	number	Total records matching the request
`from`	string	Start of the reported window
`to`	string	End of the reported window
`start_date`	string	Start of the reported range
`end_date`	string	End of the reported range
`skipped_count`	number	Emails skipped
`failed_count`	number	Failed sends
`stopped_count`	number	Stopped leads
`unsubscribed_count`	number	Unsubscribes
`unique_sent_count`	number	Unique leads emailed
`unique_open_count`	number	Unique opens
`unique_click_count`	number	Unique clicks
`block_count`	number	Blocked sends, or leads skipped by the block list
`drafted_count`	number	Drafted emails
`sequence_count`	number	Sequence steps in the campaign
`duplicate_count`	number	Duplicate leads skipped on import
`invalid_email_count`	number	Leads skipped for an invalid email
`invalid_emails`	array	Emails rejected as invalid
`already_added_to_campaign`	number	Leads already in the campaign
`unsubscribed_leads`	array	Leads skipped because they unsubscribed
`lead_import_stopped_count`	number	Leads whose import was stopped
`is_lead_limit_exhausted`	boolean	Whether the plan lead limit was hit
`is_last_sequence`	boolean	Whether the lead was on the final step
`next_sequence_id`	number	ID of the next sequence step
`next_sequence_delay_in_days`	number	Days before the next step
`first_name`	string	Lead first name
`last_name`	string	Lead last name
`phone_number`	string	Lead phone number
`company_name`	string	Lead company name
`website`	string	Lead website
`location`	string	Lead location
`linkedin_profile`	string	Lead LinkedIn profile URL
`company_url`	string	Lead company URL
`custom_fields`	json	Lead custom fields
`is_unsubscribed`	boolean	Whether the lead is unsubscribed
`lead_campaign_data`	array	Campaigns the lead belongs to
`created_at`	string	Creation timestamp
`updated_at`	string	Last update timestamp
`leads_count`	number	Leads in the list
`active_leads_count`	number	Active leads in the list
`track_settings`	array	Disabled tracking settings
`scheduler_cron_value`	json	Campaign sending schedule
`accounts`	array	Sending email accounts, excluding their stored mailbox credentials
`user_id`	number	Owning Smartlead user ID
`min_time_btwn_emails`	number	Minimum minutes between emails
`max_leads_per_day`	number	Maximum new leads per day
`stop_lead_settings`	string	Activity that stops a lead sequence
`schedule_start_time`	string	Scheduled start time
`enable_ai_esp_matching`	boolean	Whether AI ESP matching is enabled
`send_as_plain_text`	boolean	Whether emails send as plain text
`follow_up_percentage`	number	Follow-up percentage
`unsubscribe_text`	string	Unsubscribe text
`parent_campaign_id`	number	Parent campaign ID
`client_id`	number	Client ID for agency accounts
`client_name`	string	Client name
`client_email`	string	Client email
`client_company_name`	string	Client company name
`tags`	array	Tags on the record
`email_campaign_id`	number	Campaign the webhook belongs to

Smartlead Get Lead Message History

Retrieves the sent-and-received message history for a lead in a Smartlead campaign.

Input

Parameter	Type	Required	Description

Output

Parameter	Type	Description
`campaigns`	array	List of campaigns
`leads`	array	List of leads
`sequences`	array	Email sequence steps
`categories`	array	Lead categories
`webhooks`	array	Campaign webhooks
`stats`	array	Per-email statistics rows
`history`	array	Lead message history
`count`	number	Number of records returned
`total_leads`	number	Total leads in the campaign, or leads newly added when importing
`total_stats`	number	Total statistics rows matching the filters
`id`	number	Record ID
`name`	string	Record name
`status`	string	Campaign status
`email`	string	Lead email address
`webhook_url`	string	Webhook destination URL
`event_types`	array	Webhook event types
`sent_count`	number	Emails sent
`open_count`	number	Email opens
`click_count`	number	Link clicks
`reply_count`	number	Replies
`bounce_count`	number	Bounces
`campaign_lead_stats`	json	Lead counts by state
`upload_count`	number	Leads submitted in the request
`success`	boolean	Whether the action succeeded
`items`	array	Records returned by Smartlead
`rows`	array	Rows returned by Smartlead
`lists`	array	Lead lists
`summary`	array	Webhook delivery summary rows
`csv`	string	Exported leads as CSV
`row_count`	number	Rows in the exported CSV
`has_more`	boolean	Whether more rows are available
`list_name`	string	Lead list name
`positive_reply_count`	number	Replies categorized as positive
`offset`	number	Pagination offset used
`limit`	number	Pagination limit used
`total_count`	number	Total records matching the request
`from`	string	Start of the reported window
`to`	string	End of the reported window
`start_date`	string	Start of the reported range
`end_date`	string	End of the reported range
`skipped_count`	number	Emails skipped
`failed_count`	number	Failed sends
`stopped_count`	number	Stopped leads
`unsubscribed_count`	number	Unsubscribes
`unique_sent_count`	number	Unique leads emailed
`unique_open_count`	number	Unique opens
`unique_click_count`	number	Unique clicks
`block_count`	number	Blocked sends, or leads skipped by the block list
`drafted_count`	number	Drafted emails
`sequence_count`	number	Sequence steps in the campaign
`duplicate_count`	number	Duplicate leads skipped on import
`invalid_email_count`	number	Leads skipped for an invalid email
`invalid_emails`	array	Emails rejected as invalid
`already_added_to_campaign`	number	Leads already in the campaign
`unsubscribed_leads`	array	Leads skipped because they unsubscribed
`lead_import_stopped_count`	number	Leads whose import was stopped
`is_lead_limit_exhausted`	boolean	Whether the plan lead limit was hit
`is_last_sequence`	boolean	Whether the lead was on the final step
`next_sequence_id`	number	ID of the next sequence step
`next_sequence_delay_in_days`	number	Days before the next step
`first_name`	string	Lead first name
`last_name`	string	Lead last name
`phone_number`	string	Lead phone number
`company_name`	string	Lead company name
`website`	string	Lead website
`location`	string	Lead location
`linkedin_profile`	string	Lead LinkedIn profile URL
`company_url`	string	Lead company URL
`custom_fields`	json	Lead custom fields
`is_unsubscribed`	boolean	Whether the lead is unsubscribed
`lead_campaign_data`	array	Campaigns the lead belongs to
`created_at`	string	Creation timestamp
`updated_at`	string	Last update timestamp
`leads_count`	number	Leads in the list
`active_leads_count`	number	Active leads in the list
`track_settings`	array	Disabled tracking settings
`scheduler_cron_value`	json	Campaign sending schedule
`accounts`	array	Sending email accounts, excluding their stored mailbox credentials
`user_id`	number	Owning Smartlead user ID
`min_time_btwn_emails`	number	Minimum minutes between emails
`max_leads_per_day`	number	Maximum new leads per day
`stop_lead_settings`	string	Activity that stops a lead sequence
`schedule_start_time`	string	Scheduled start time
`enable_ai_esp_matching`	boolean	Whether AI ESP matching is enabled
`send_as_plain_text`	boolean	Whether emails send as plain text
`follow_up_percentage`	number	Follow-up percentage
`unsubscribe_text`	string	Unsubscribe text
`parent_campaign_id`	number	Parent campaign ID
`client_id`	number	Client ID for agency accounts
`client_name`	string	Client name
`client_email`	string	Client email
`client_company_name`	string	Client company name
`tags`	array	Tags on the record
`email_campaign_id`	number	Campaign the webhook belongs to

Smartlead List Campaign Webhooks

Retrieves the webhooks registered on a Smartlead campaign.

Input

Parameter	Type	Required	Description

Output

Parameter	Type	Description
`campaigns`	array	List of campaigns
`leads`	array	List of leads
`sequences`	array	Email sequence steps
`categories`	array	Lead categories
`webhooks`	array	Campaign webhooks
`stats`	array	Per-email statistics rows
`history`	array	Lead message history
`count`	number	Number of records returned
`total_leads`	number	Total leads in the campaign, or leads newly added when importing
`total_stats`	number	Total statistics rows matching the filters
`id`	number	Record ID
`name`	string	Record name
`status`	string	Campaign status
`email`	string	Lead email address
`webhook_url`	string	Webhook destination URL
`event_types`	array	Webhook event types
`sent_count`	number	Emails sent
`open_count`	number	Email opens
`click_count`	number	Link clicks
`reply_count`	number	Replies
`bounce_count`	number	Bounces
`campaign_lead_stats`	json	Lead counts by state
`upload_count`	number	Leads submitted in the request
`success`	boolean	Whether the action succeeded
`items`	array	Records returned by Smartlead
`rows`	array	Rows returned by Smartlead
`lists`	array	Lead lists
`summary`	array	Webhook delivery summary rows
`csv`	string	Exported leads as CSV
`row_count`	number	Rows in the exported CSV
`has_more`	boolean	Whether more rows are available
`list_name`	string	Lead list name
`positive_reply_count`	number	Replies categorized as positive
`offset`	number	Pagination offset used
`limit`	number	Pagination limit used
`total_count`	number	Total records matching the request
`from`	string	Start of the reported window
`to`	string	End of the reported window
`start_date`	string	Start of the reported range
`end_date`	string	End of the reported range
`skipped_count`	number	Emails skipped
`failed_count`	number	Failed sends
`stopped_count`	number	Stopped leads
`unsubscribed_count`	number	Unsubscribes
`unique_sent_count`	number	Unique leads emailed
`unique_open_count`	number	Unique opens
`unique_click_count`	number	Unique clicks
`block_count`	number	Blocked sends, or leads skipped by the block list
`drafted_count`	number	Drafted emails
`sequence_count`	number	Sequence steps in the campaign
`duplicate_count`	number	Duplicate leads skipped on import
`invalid_email_count`	number	Leads skipped for an invalid email
`invalid_emails`	array	Emails rejected as invalid
`already_added_to_campaign`	number	Leads already in the campaign
`unsubscribed_leads`	array	Leads skipped because they unsubscribed
`lead_import_stopped_count`	number	Leads whose import was stopped
`is_lead_limit_exhausted`	boolean	Whether the plan lead limit was hit
`is_last_sequence`	boolean	Whether the lead was on the final step
`next_sequence_id`	number	ID of the next sequence step
`next_sequence_delay_in_days`	number	Days before the next step
`first_name`	string	Lead first name
`last_name`	string	Lead last name
`phone_number`	string	Lead phone number
`company_name`	string	Lead company name
`website`	string	Lead website
`location`	string	Lead location
`linkedin_profile`	string	Lead LinkedIn profile URL
`company_url`	string	Lead company URL
`custom_fields`	json	Lead custom fields
`is_unsubscribed`	boolean	Whether the lead is unsubscribed
`lead_campaign_data`	array	Campaigns the lead belongs to
`created_at`	string	Creation timestamp
`updated_at`	string	Last update timestamp
`leads_count`	number	Leads in the list
`active_leads_count`	number	Active leads in the list
`track_settings`	array	Disabled tracking settings
`scheduler_cron_value`	json	Campaign sending schedule
`accounts`	array	Sending email accounts, excluding their stored mailbox credentials
`user_id`	number	Owning Smartlead user ID
`min_time_btwn_emails`	number	Minimum minutes between emails
`max_leads_per_day`	number	Maximum new leads per day
`stop_lead_settings`	string	Activity that stops a lead sequence
`schedule_start_time`	string	Scheduled start time
`enable_ai_esp_matching`	boolean	Whether AI ESP matching is enabled
`send_as_plain_text`	boolean	Whether emails send as plain text
`follow_up_percentage`	number	Follow-up percentage
`unsubscribe_text`	string	Unsubscribe text
`parent_campaign_id`	number	Parent campaign ID
`client_id`	number	Client ID for agency accounts
`client_name`	string	Client name
`client_email`	string	Client email
`client_company_name`	string	Client company name
`tags`	array	Tags on the record
`email_campaign_id`	number	Campaign the webhook belongs to

Smartlead Create or Update Campaign Webhook

Creates a webhook on a Smartlead campaign, or updates an existing one when a webhook ID is supplied. Smartlead requires at least one lead category.

Input

Parameter	Type	Required	Description
`name`	string	Yes	Webhook name
`webhookUrl`	string	Yes	HTTPS URL Smartlead should post events to
`eventTypes`	array	Yes	Events to subscribe to. Allowed values: EMAIL_SENT, EMAIL_OPEN, EMAIL_LINK_CLICK, EMAIL_REPLY, EMAIL_BOUNCE, LEAD_UNSUBSCRIBED, LEAD_CATEGORY_UPDATED
`categories`	array	Yes	Lead category names the webhook applies to, e.g. Interested. Smartlead rejects an empty list.
`webhookId`	number	No	Existing webhook ID to update; omit to create a new webhook

Output

Parameter	Type	Description
`campaigns`	array	List of campaigns
`leads`	array	List of leads
`sequences`	array	Email sequence steps
`categories`	array	Lead categories
`webhooks`	array	Campaign webhooks
`stats`	array	Per-email statistics rows
`history`	array	Lead message history
`count`	number	Number of records returned
`total_leads`	number	Total leads in the campaign, or leads newly added when importing
`total_stats`	number	Total statistics rows matching the filters
`id`	number	Record ID
`name`	string	Record name
`status`	string	Campaign status
`email`	string	Lead email address
`webhook_url`	string	Webhook destination URL
`event_types`	array	Webhook event types
`sent_count`	number	Emails sent
`open_count`	number	Email opens
`click_count`	number	Link clicks
`reply_count`	number	Replies
`bounce_count`	number	Bounces
`campaign_lead_stats`	json	Lead counts by state
`upload_count`	number	Leads submitted in the request
`success`	boolean	Whether the action succeeded
`items`	array	Records returned by Smartlead
`rows`	array	Rows returned by Smartlead
`lists`	array	Lead lists
`summary`	array	Webhook delivery summary rows
`csv`	string	Exported leads as CSV
`row_count`	number	Rows in the exported CSV
`has_more`	boolean	Whether more rows are available
`list_name`	string	Lead list name
`positive_reply_count`	number	Replies categorized as positive
`offset`	number	Pagination offset used
`limit`	number	Pagination limit used
`total_count`	number	Total records matching the request
`from`	string	Start of the reported window
`to`	string	End of the reported window
`start_date`	string	Start of the reported range
`end_date`	string	End of the reported range
`skipped_count`	number	Emails skipped
`failed_count`	number	Failed sends
`stopped_count`	number	Stopped leads
`unsubscribed_count`	number	Unsubscribes
`unique_sent_count`	number	Unique leads emailed
`unique_open_count`	number	Unique opens
`unique_click_count`	number	Unique clicks
`block_count`	number	Blocked sends, or leads skipped by the block list
`drafted_count`	number	Drafted emails
`sequence_count`	number	Sequence steps in the campaign
`duplicate_count`	number	Duplicate leads skipped on import
`invalid_email_count`	number	Leads skipped for an invalid email
`invalid_emails`	array	Emails rejected as invalid
`already_added_to_campaign`	number	Leads already in the campaign
`unsubscribed_leads`	array	Leads skipped because they unsubscribed
`lead_import_stopped_count`	number	Leads whose import was stopped
`is_lead_limit_exhausted`	boolean	Whether the plan lead limit was hit
`is_last_sequence`	boolean	Whether the lead was on the final step
`next_sequence_id`	number	ID of the next sequence step
`next_sequence_delay_in_days`	number	Days before the next step
`first_name`	string	Lead first name
`last_name`	string	Lead last name
`phone_number`	string	Lead phone number
`company_name`	string	Lead company name
`website`	string	Lead website
`location`	string	Lead location
`linkedin_profile`	string	Lead LinkedIn profile URL
`company_url`	string	Lead company URL
`custom_fields`	json	Lead custom fields
`is_unsubscribed`	boolean	Whether the lead is unsubscribed
`lead_campaign_data`	array	Campaigns the lead belongs to
`created_at`	string	Creation timestamp
`updated_at`	string	Last update timestamp
`leads_count`	number	Leads in the list
`active_leads_count`	number	Active leads in the list
`track_settings`	array	Disabled tracking settings
`scheduler_cron_value`	json	Campaign sending schedule
`accounts`	array	Sending email accounts, excluding their stored mailbox credentials
`user_id`	number	Owning Smartlead user ID
`min_time_btwn_emails`	number	Minimum minutes between emails
`max_leads_per_day`	number	Maximum new leads per day
`stop_lead_settings`	string	Activity that stops a lead sequence
`schedule_start_time`	string	Scheduled start time
`enable_ai_esp_matching`	boolean	Whether AI ESP matching is enabled
`send_as_plain_text`	boolean	Whether emails send as plain text
`follow_up_percentage`	number	Follow-up percentage
`unsubscribe_text`	string	Unsubscribe text
`parent_campaign_id`	number	Parent campaign ID
`client_id`	number	Client ID for agency accounts
`client_name`	string	Client name
`client_email`	string	Client email
`client_company_name`	string	Client company name
`tags`	array	Tags on the record
`email_campaign_id`	number	Campaign the webhook belongs to

Smartlead Delete Campaign Webhook

Deletes a webhook from a Smartlead campaign.

Input

Parameter	Type	Required	Description
`webhookId`	number	Yes	ID of the webhook to delete, from List Campaign Webhooks

Output

Parameter	Type	Description
`campaigns`	array	List of campaigns
`leads`	array	List of leads
`sequences`	array	Email sequence steps
`categories`	array	Lead categories
`webhooks`	array	Campaign webhooks
`stats`	array	Per-email statistics rows
`history`	array	Lead message history
`count`	number	Number of records returned
`total_leads`	number	Total leads in the campaign, or leads newly added when importing
`total_stats`	number	Total statistics rows matching the filters
`id`	number	Record ID
`name`	string	Record name
`status`	string	Campaign status
`email`	string	Lead email address
`webhook_url`	string	Webhook destination URL
`event_types`	array	Webhook event types
`sent_count`	number	Emails sent
`open_count`	number	Email opens
`click_count`	number	Link clicks
`reply_count`	number	Replies
`bounce_count`	number	Bounces
`campaign_lead_stats`	json	Lead counts by state
`upload_count`	number	Leads submitted in the request
`success`	boolean	Whether the action succeeded
`items`	array	Records returned by Smartlead
`rows`	array	Rows returned by Smartlead
`lists`	array	Lead lists
`summary`	array	Webhook delivery summary rows
`csv`	string	Exported leads as CSV
`row_count`	number	Rows in the exported CSV
`has_more`	boolean	Whether more rows are available
`list_name`	string	Lead list name
`positive_reply_count`	number	Replies categorized as positive
`offset`	number	Pagination offset used
`limit`	number	Pagination limit used
`total_count`	number	Total records matching the request
`from`	string	Start of the reported window
`to`	string	End of the reported window
`start_date`	string	Start of the reported range
`end_date`	string	End of the reported range
`skipped_count`	number	Emails skipped
`failed_count`	number	Failed sends
`stopped_count`	number	Stopped leads
`unsubscribed_count`	number	Unsubscribes
`unique_sent_count`	number	Unique leads emailed
`unique_open_count`	number	Unique opens
`unique_click_count`	number	Unique clicks
`block_count`	number	Blocked sends, or leads skipped by the block list
`drafted_count`	number	Drafted emails
`sequence_count`	number	Sequence steps in the campaign
`duplicate_count`	number	Duplicate leads skipped on import
`invalid_email_count`	number	Leads skipped for an invalid email
`invalid_emails`	array	Emails rejected as invalid
`already_added_to_campaign`	number	Leads already in the campaign
`unsubscribed_leads`	array	Leads skipped because they unsubscribed
`lead_import_stopped_count`	number	Leads whose import was stopped
`is_lead_limit_exhausted`	boolean	Whether the plan lead limit was hit
`is_last_sequence`	boolean	Whether the lead was on the final step
`next_sequence_id`	number	ID of the next sequence step
`next_sequence_delay_in_days`	number	Days before the next step
`first_name`	string	Lead first name
`last_name`	string	Lead last name
`phone_number`	string	Lead phone number
`company_name`	string	Lead company name
`website`	string	Lead website
`location`	string	Lead location
`linkedin_profile`	string	Lead LinkedIn profile URL
`company_url`	string	Lead company URL
`custom_fields`	json	Lead custom fields
`is_unsubscribed`	boolean	Whether the lead is unsubscribed
`lead_campaign_data`	array	Campaigns the lead belongs to
`created_at`	string	Creation timestamp
`updated_at`	string	Last update timestamp
`leads_count`	number	Leads in the list
`active_leads_count`	number	Active leads in the list
`track_settings`	array	Disabled tracking settings
`scheduler_cron_value`	json	Campaign sending schedule
`accounts`	array	Sending email accounts, excluding their stored mailbox credentials
`user_id`	number	Owning Smartlead user ID
`min_time_btwn_emails`	number	Minimum minutes between emails
`max_leads_per_day`	number	Maximum new leads per day
`stop_lead_settings`	string	Activity that stops a lead sequence
`schedule_start_time`	string	Scheduled start time
`enable_ai_esp_matching`	boolean	Whether AI ESP matching is enabled
`send_as_plain_text`	boolean	Whether emails send as plain text
`follow_up_percentage`	number	Follow-up percentage
`unsubscribe_text`	string	Unsubscribe text
`parent_campaign_id`	number	Parent campaign ID
`client_id`	number	Client ID for agency accounts
`client_name`	string	Client name
`client_email`	string	Client email
`client_company_name`	string	Client company name
`tags`	array	Tags on the record
`email_campaign_id`	number	Campaign the webhook belongs to

Smartlead Get Campaign Webhook Summary

Retrieves webhook delivery counts for a Smartlead campaign over a time window, for checking whether events are reaching their destination.

Input

Parameter	Type	Required	Description
`fromTime`	string	Yes	Start of the window as an ISO 8601 timestamp
`toTime`	string	Yes	End of the window as an ISO 8601 timestamp

Output

Parameter	Type	Description
`campaigns`	array	List of campaigns
`leads`	array	List of leads
`sequences`	array	Email sequence steps
`categories`	array	Lead categories
`webhooks`	array	Campaign webhooks
`stats`	array	Per-email statistics rows
`history`	array	Lead message history
`count`	number	Number of records returned
`total_leads`	number	Total leads in the campaign, or leads newly added when importing
`total_stats`	number	Total statistics rows matching the filters
`id`	number	Record ID
`name`	string	Record name
`status`	string	Campaign status
`email`	string	Lead email address
`webhook_url`	string	Webhook destination URL
`event_types`	array	Webhook event types
`sent_count`	number	Emails sent
`open_count`	number	Email opens
`click_count`	number	Link clicks
`reply_count`	number	Replies
`bounce_count`	number	Bounces
`campaign_lead_stats`	json	Lead counts by state
`upload_count`	number	Leads submitted in the request
`success`	boolean	Whether the action succeeded
`items`	array	Records returned by Smartlead
`rows`	array	Rows returned by Smartlead
`lists`	array	Lead lists
`summary`	array	Webhook delivery summary rows
`csv`	string	Exported leads as CSV
`row_count`	number	Rows in the exported CSV
`has_more`	boolean	Whether more rows are available
`list_name`	string	Lead list name
`positive_reply_count`	number	Replies categorized as positive
`offset`	number	Pagination offset used
`limit`	number	Pagination limit used
`total_count`	number	Total records matching the request
`from`	string	Start of the reported window
`to`	string	End of the reported window
`start_date`	string	Start of the reported range
`end_date`	string	End of the reported range
`skipped_count`	number	Emails skipped
`failed_count`	number	Failed sends
`stopped_count`	number	Stopped leads
`unsubscribed_count`	number	Unsubscribes
`unique_sent_count`	number	Unique leads emailed
`unique_open_count`	number	Unique opens
`unique_click_count`	number	Unique clicks
`block_count`	number	Blocked sends, or leads skipped by the block list
`drafted_count`	number	Drafted emails
`sequence_count`	number	Sequence steps in the campaign
`duplicate_count`	number	Duplicate leads skipped on import
`invalid_email_count`	number	Leads skipped for an invalid email
`invalid_emails`	array	Emails rejected as invalid
`already_added_to_campaign`	number	Leads already in the campaign
`unsubscribed_leads`	array	Leads skipped because they unsubscribed
`lead_import_stopped_count`	number	Leads whose import was stopped
`is_lead_limit_exhausted`	boolean	Whether the plan lead limit was hit
`is_last_sequence`	boolean	Whether the lead was on the final step
`next_sequence_id`	number	ID of the next sequence step
`next_sequence_delay_in_days`	number	Days before the next step
`first_name`	string	Lead first name
`last_name`	string	Lead last name
`phone_number`	string	Lead phone number
`company_name`	string	Lead company name
`website`	string	Lead website
`location`	string	Lead location
`linkedin_profile`	string	Lead LinkedIn profile URL
`company_url`	string	Lead company URL
`custom_fields`	json	Lead custom fields
`is_unsubscribed`	boolean	Whether the lead is unsubscribed
`lead_campaign_data`	array	Campaigns the lead belongs to
`created_at`	string	Creation timestamp
`updated_at`	string	Last update timestamp
`leads_count`	number	Leads in the list
`active_leads_count`	number	Active leads in the list
`track_settings`	array	Disabled tracking settings
`scheduler_cron_value`	json	Campaign sending schedule
`accounts`	array	Sending email accounts, excluding their stored mailbox credentials
`user_id`	number	Owning Smartlead user ID
`min_time_btwn_emails`	number	Minimum minutes between emails
`max_leads_per_day`	number	Maximum new leads per day
`stop_lead_settings`	string	Activity that stops a lead sequence
`schedule_start_time`	string	Scheduled start time
`enable_ai_esp_matching`	boolean	Whether AI ESP matching is enabled
`send_as_plain_text`	boolean	Whether emails send as plain text
`follow_up_percentage`	number	Follow-up percentage
`unsubscribe_text`	string	Unsubscribe text
`parent_campaign_id`	number	Parent campaign ID
`client_id`	number	Client ID for agency accounts
`client_name`	string	Client name
`client_email`	string	Client email
`client_company_name`	string	Client company name
`tags`	array	Tags on the record
`email_campaign_id`	number	Campaign the webhook belongs to

Smartlead Duplicate Campaign

Copies a Smartlead campaign, including its sequences and settings. The copy is named "<original> - copy" and starts in DRAFTED status.

Input

Parameter	Type	Required	Description

Output

Parameter	Type	Description
`campaigns`	array	List of campaigns
`leads`	array	List of leads
`sequences`	array	Email sequence steps
`categories`	array	Lead categories
`webhooks`	array	Campaign webhooks
`stats`	array	Per-email statistics rows
`history`	array	Lead message history
`count`	number	Number of records returned
`total_leads`	number	Total leads in the campaign, or leads newly added when importing
`total_stats`	number	Total statistics rows matching the filters
`id`	number	Record ID
`name`	string	Record name
`status`	string	Campaign status
`email`	string	Lead email address
`webhook_url`	string	Webhook destination URL
`event_types`	array	Webhook event types
`sent_count`	number	Emails sent
`open_count`	number	Email opens
`click_count`	number	Link clicks
`reply_count`	number	Replies
`bounce_count`	number	Bounces
`campaign_lead_stats`	json	Lead counts by state
`upload_count`	number	Leads submitted in the request
`success`	boolean	Whether the action succeeded
`items`	array	Records returned by Smartlead
`rows`	array	Rows returned by Smartlead
`lists`	array	Lead lists
`summary`	array	Webhook delivery summary rows
`csv`	string	Exported leads as CSV
`row_count`	number	Rows in the exported CSV
`has_more`	boolean	Whether more rows are available
`list_name`	string	Lead list name
`positive_reply_count`	number	Replies categorized as positive
`offset`	number	Pagination offset used
`limit`	number	Pagination limit used
`total_count`	number	Total records matching the request
`from`	string	Start of the reported window
`to`	string	End of the reported window
`start_date`	string	Start of the reported range
`end_date`	string	End of the reported range
`skipped_count`	number	Emails skipped
`failed_count`	number	Failed sends
`stopped_count`	number	Stopped leads
`unsubscribed_count`	number	Unsubscribes
`unique_sent_count`	number	Unique leads emailed
`unique_open_count`	number	Unique opens
`unique_click_count`	number	Unique clicks
`block_count`	number	Blocked sends, or leads skipped by the block list
`drafted_count`	number	Drafted emails
`sequence_count`	number	Sequence steps in the campaign
`duplicate_count`	number	Duplicate leads skipped on import
`invalid_email_count`	number	Leads skipped for an invalid email
`invalid_emails`	array	Emails rejected as invalid
`already_added_to_campaign`	number	Leads already in the campaign
`unsubscribed_leads`	array	Leads skipped because they unsubscribed
`lead_import_stopped_count`	number	Leads whose import was stopped
`is_lead_limit_exhausted`	boolean	Whether the plan lead limit was hit
`is_last_sequence`	boolean	Whether the lead was on the final step
`next_sequence_id`	number	ID of the next sequence step
`next_sequence_delay_in_days`	number	Days before the next step
`first_name`	string	Lead first name
`last_name`	string	Lead last name
`phone_number`	string	Lead phone number
`company_name`	string	Lead company name
`website`	string	Lead website
`location`	string	Lead location
`linkedin_profile`	string	Lead LinkedIn profile URL
`company_url`	string	Lead company URL
`custom_fields`	json	Lead custom fields
`is_unsubscribed`	boolean	Whether the lead is unsubscribed
`lead_campaign_data`	array	Campaigns the lead belongs to
`created_at`	string	Creation timestamp
`updated_at`	string	Last update timestamp
`leads_count`	number	Leads in the list
`active_leads_count`	number	Active leads in the list
`track_settings`	array	Disabled tracking settings
`scheduler_cron_value`	json	Campaign sending schedule
`accounts`	array	Sending email accounts, excluding their stored mailbox credentials
`user_id`	number	Owning Smartlead user ID
`min_time_btwn_emails`	number	Minimum minutes between emails
`max_leads_per_day`	number	Maximum new leads per day
`stop_lead_settings`	string	Activity that stops a lead sequence
`schedule_start_time`	string	Scheduled start time
`enable_ai_esp_matching`	boolean	Whether AI ESP matching is enabled
`send_as_plain_text`	boolean	Whether emails send as plain text
`follow_up_percentage`	number	Follow-up percentage
`unsubscribe_text`	string	Unsubscribe text
`parent_campaign_id`	number	Parent campaign ID
`client_id`	number	Client ID for agency accounts
`client_name`	string	Client name
`client_email`	string	Client email
`client_company_name`	string	Client company name
`tags`	array	Tags on the record
`email_campaign_id`	number	Campaign the webhook belongs to

Smartlead Delete Campaign

Permanently deletes a Smartlead campaign along with its sequences, leads, and webhooks. This cannot be undone.

Input

Parameter	Type	Required	Description

Output

Parameter	Type	Description
`campaigns`	array	List of campaigns
`leads`	array	List of leads
`sequences`	array	Email sequence steps
`categories`	array	Lead categories
`webhooks`	array	Campaign webhooks
`stats`	array	Per-email statistics rows
`history`	array	Lead message history
`count`	number	Number of records returned
`total_leads`	number	Total leads in the campaign, or leads newly added when importing
`total_stats`	number	Total statistics rows matching the filters
`id`	number	Record ID
`name`	string	Record name
`status`	string	Campaign status
`email`	string	Lead email address
`webhook_url`	string	Webhook destination URL
`event_types`	array	Webhook event types
`sent_count`	number	Emails sent
`open_count`	number	Email opens
`click_count`	number	Link clicks
`reply_count`	number	Replies
`bounce_count`	number	Bounces
`campaign_lead_stats`	json	Lead counts by state
`upload_count`	number	Leads submitted in the request
`success`	boolean	Whether the action succeeded
`items`	array	Records returned by Smartlead
`rows`	array	Rows returned by Smartlead
`lists`	array	Lead lists
`summary`	array	Webhook delivery summary rows
`csv`	string	Exported leads as CSV
`row_count`	number	Rows in the exported CSV
`has_more`	boolean	Whether more rows are available
`list_name`	string	Lead list name
`positive_reply_count`	number	Replies categorized as positive
`offset`	number	Pagination offset used
`limit`	number	Pagination limit used
`total_count`	number	Total records matching the request
`from`	string	Start of the reported window
`to`	string	End of the reported window
`start_date`	string	Start of the reported range
`end_date`	string	End of the reported range
`skipped_count`	number	Emails skipped
`failed_count`	number	Failed sends
`stopped_count`	number	Stopped leads
`unsubscribed_count`	number	Unsubscribes
`unique_sent_count`	number	Unique leads emailed
`unique_open_count`	number	Unique opens
`unique_click_count`	number	Unique clicks
`block_count`	number	Blocked sends, or leads skipped by the block list
`drafted_count`	number	Drafted emails
`sequence_count`	number	Sequence steps in the campaign
`duplicate_count`	number	Duplicate leads skipped on import
`invalid_email_count`	number	Leads skipped for an invalid email
`invalid_emails`	array	Emails rejected as invalid
`already_added_to_campaign`	number	Leads already in the campaign
`unsubscribed_leads`	array	Leads skipped because they unsubscribed
`lead_import_stopped_count`	number	Leads whose import was stopped
`is_lead_limit_exhausted`	boolean	Whether the plan lead limit was hit
`is_last_sequence`	boolean	Whether the lead was on the final step
`next_sequence_id`	number	ID of the next sequence step
`next_sequence_delay_in_days`	number	Days before the next step
`first_name`	string	Lead first name
`last_name`	string	Lead last name
`phone_number`	string	Lead phone number
`company_name`	string	Lead company name
`website`	string	Lead website
`location`	string	Lead location
`linkedin_profile`	string	Lead LinkedIn profile URL
`company_url`	string	Lead company URL
`custom_fields`	json	Lead custom fields
`is_unsubscribed`	boolean	Whether the lead is unsubscribed
`lead_campaign_data`	array	Campaigns the lead belongs to
`created_at`	string	Creation timestamp
`updated_at`	string	Last update timestamp
`leads_count`	number	Leads in the list
`active_leads_count`	number	Active leads in the list
`track_settings`	array	Disabled tracking settings
`scheduler_cron_value`	json	Campaign sending schedule
`accounts`	array	Sending email accounts, excluding their stored mailbox credentials
`user_id`	number	Owning Smartlead user ID
`min_time_btwn_emails`	number	Minimum minutes between emails
`max_leads_per_day`	number	Maximum new leads per day
`stop_lead_settings`	string	Activity that stops a lead sequence
`schedule_start_time`	string	Scheduled start time
`enable_ai_esp_matching`	boolean	Whether AI ESP matching is enabled
`send_as_plain_text`	boolean	Whether emails send as plain text
`follow_up_percentage`	number	Follow-up percentage
`unsubscribe_text`	string	Unsubscribe text
`parent_campaign_id`	number	Parent campaign ID
`client_id`	number	Client ID for agency accounts
`client_name`	string	Client name
`client_email`	string	Client email
`client_company_name`	string	Client company name
`tags`	array	Tags on the record
`email_campaign_id`	number	Campaign the webhook belongs to

Smartlead Export Campaign Leads

Exports every lead in a Smartlead campaign as CSV, including engagement counts and the sequence step last sent to each lead.

Input

Parameter	Type	Required	Description

Output

Parameter	Type	Description
`campaigns`	array	List of campaigns
`leads`	array	List of leads
`sequences`	array	Email sequence steps
`categories`	array	Lead categories
`webhooks`	array	Campaign webhooks
`stats`	array	Per-email statistics rows
`history`	array	Lead message history
`count`	number	Number of records returned
`total_leads`	number	Total leads in the campaign, or leads newly added when importing
`total_stats`	number	Total statistics rows matching the filters
`id`	number	Record ID
`name`	string	Record name
`status`	string	Campaign status
`email`	string	Lead email address
`webhook_url`	string	Webhook destination URL
`event_types`	array	Webhook event types
`sent_count`	number	Emails sent
`open_count`	number	Email opens
`click_count`	number	Link clicks
`reply_count`	number	Replies
`bounce_count`	number	Bounces
`campaign_lead_stats`	json	Lead counts by state
`upload_count`	number	Leads submitted in the request
`success`	boolean	Whether the action succeeded
`items`	array	Records returned by Smartlead
`rows`	array	Rows returned by Smartlead
`lists`	array	Lead lists
`summary`	array	Webhook delivery summary rows
`csv`	string	Exported leads as CSV
`row_count`	number	Rows in the exported CSV
`has_more`	boolean	Whether more rows are available
`list_name`	string	Lead list name
`positive_reply_count`	number	Replies categorized as positive
`offset`	number	Pagination offset used
`limit`	number	Pagination limit used
`total_count`	number	Total records matching the request
`from`	string	Start of the reported window
`to`	string	End of the reported window
`start_date`	string	Start of the reported range
`end_date`	string	End of the reported range
`skipped_count`	number	Emails skipped
`failed_count`	number	Failed sends
`stopped_count`	number	Stopped leads
`unsubscribed_count`	number	Unsubscribes
`unique_sent_count`	number	Unique leads emailed
`unique_open_count`	number	Unique opens
`unique_click_count`	number	Unique clicks
`block_count`	number	Blocked sends, or leads skipped by the block list
`drafted_count`	number	Drafted emails
`sequence_count`	number	Sequence steps in the campaign
`duplicate_count`	number	Duplicate leads skipped on import
`invalid_email_count`	number	Leads skipped for an invalid email
`invalid_emails`	array	Emails rejected as invalid
`already_added_to_campaign`	number	Leads already in the campaign
`unsubscribed_leads`	array	Leads skipped because they unsubscribed
`lead_import_stopped_count`	number	Leads whose import was stopped
`is_lead_limit_exhausted`	boolean	Whether the plan lead limit was hit
`is_last_sequence`	boolean	Whether the lead was on the final step
`next_sequence_id`	number	ID of the next sequence step
`next_sequence_delay_in_days`	number	Days before the next step
`first_name`	string	Lead first name
`last_name`	string	Lead last name
`phone_number`	string	Lead phone number
`company_name`	string	Lead company name
`website`	string	Lead website
`location`	string	Lead location
`linkedin_profile`	string	Lead LinkedIn profile URL
`company_url`	string	Lead company URL
`custom_fields`	json	Lead custom fields
`is_unsubscribed`	boolean	Whether the lead is unsubscribed
`lead_campaign_data`	array	Campaigns the lead belongs to
`created_at`	string	Creation timestamp
`updated_at`	string	Last update timestamp
`leads_count`	number	Leads in the list
`active_leads_count`	number	Active leads in the list
`track_settings`	array	Disabled tracking settings
`scheduler_cron_value`	json	Campaign sending schedule
`accounts`	array	Sending email accounts, excluding their stored mailbox credentials
`user_id`	number	Owning Smartlead user ID
`min_time_btwn_emails`	number	Minimum minutes between emails
`max_leads_per_day`	number	Maximum new leads per day
`stop_lead_settings`	string	Activity that stops a lead sequence
`schedule_start_time`	string	Scheduled start time
`enable_ai_esp_matching`	boolean	Whether AI ESP matching is enabled
`send_as_plain_text`	boolean	Whether emails send as plain text
`follow_up_percentage`	number	Follow-up percentage
`unsubscribe_text`	string	Unsubscribe text
`parent_campaign_id`	number	Parent campaign ID
`client_id`	number	Client ID for agency accounts
`client_name`	string	Client name
`client_email`	string	Client email
`client_company_name`	string	Client company name
`tags`	array	Tags on the record
`email_campaign_id`	number	Campaign the webhook belongs to

Smartlead List Campaign Email Accounts

Retrieves the sending email accounts attached to a Smartlead campaign.

Input

Parameter	Type	Required	Description

Output

Parameter	Type	Description
`campaigns`	array	List of campaigns
`leads`	array	List of leads
`sequences`	array	Email sequence steps
`categories`	array	Lead categories
`webhooks`	array	Campaign webhooks
`stats`	array	Per-email statistics rows
`history`	array	Lead message history
`count`	number	Number of records returned
`total_leads`	number	Total leads in the campaign, or leads newly added when importing
`total_stats`	number	Total statistics rows matching the filters
`id`	number	Record ID
`name`	string	Record name
`status`	string	Campaign status
`email`	string	Lead email address
`webhook_url`	string	Webhook destination URL
`event_types`	array	Webhook event types
`sent_count`	number	Emails sent
`open_count`	number	Email opens
`click_count`	number	Link clicks
`reply_count`	number	Replies
`bounce_count`	number	Bounces
`campaign_lead_stats`	json	Lead counts by state
`upload_count`	number	Leads submitted in the request
`success`	boolean	Whether the action succeeded
`items`	array	Records returned by Smartlead
`rows`	array	Rows returned by Smartlead
`lists`	array	Lead lists
`summary`	array	Webhook delivery summary rows
`csv`	string	Exported leads as CSV
`row_count`	number	Rows in the exported CSV
`has_more`	boolean	Whether more rows are available
`list_name`	string	Lead list name
`positive_reply_count`	number	Replies categorized as positive
`offset`	number	Pagination offset used
`limit`	number	Pagination limit used
`total_count`	number	Total records matching the request
`from`	string	Start of the reported window
`to`	string	End of the reported window
`start_date`	string	Start of the reported range
`end_date`	string	End of the reported range
`skipped_count`	number	Emails skipped
`failed_count`	number	Failed sends
`stopped_count`	number	Stopped leads
`unsubscribed_count`	number	Unsubscribes
`unique_sent_count`	number	Unique leads emailed
`unique_open_count`	number	Unique opens
`unique_click_count`	number	Unique clicks
`block_count`	number	Blocked sends, or leads skipped by the block list
`drafted_count`	number	Drafted emails
`sequence_count`	number	Sequence steps in the campaign
`duplicate_count`	number	Duplicate leads skipped on import
`invalid_email_count`	number	Leads skipped for an invalid email
`invalid_emails`	array	Emails rejected as invalid
`already_added_to_campaign`	number	Leads already in the campaign
`unsubscribed_leads`	array	Leads skipped because they unsubscribed
`lead_import_stopped_count`	number	Leads whose import was stopped
`is_lead_limit_exhausted`	boolean	Whether the plan lead limit was hit
`is_last_sequence`	boolean	Whether the lead was on the final step
`next_sequence_id`	number	ID of the next sequence step
`next_sequence_delay_in_days`	number	Days before the next step
`first_name`	string	Lead first name
`last_name`	string	Lead last name
`phone_number`	string	Lead phone number
`company_name`	string	Lead company name
`website`	string	Lead website
`location`	string	Lead location
`linkedin_profile`	string	Lead LinkedIn profile URL
`company_url`	string	Lead company URL
`custom_fields`	json	Lead custom fields
`is_unsubscribed`	boolean	Whether the lead is unsubscribed
`lead_campaign_data`	array	Campaigns the lead belongs to
`created_at`	string	Creation timestamp
`updated_at`	string	Last update timestamp
`leads_count`	number	Leads in the list
`active_leads_count`	number	Active leads in the list
`track_settings`	array	Disabled tracking settings
`scheduler_cron_value`	json	Campaign sending schedule
`accounts`	array	Sending email accounts, excluding their stored mailbox credentials
`user_id`	number	Owning Smartlead user ID
`min_time_btwn_emails`	number	Minimum minutes between emails
`max_leads_per_day`	number	Maximum new leads per day
`stop_lead_settings`	string	Activity that stops a lead sequence
`schedule_start_time`	string	Scheduled start time
`enable_ai_esp_matching`	boolean	Whether AI ESP matching is enabled
`send_as_plain_text`	boolean	Whether emails send as plain text
`follow_up_percentage`	number	Follow-up percentage
`unsubscribe_text`	string	Unsubscribe text
`parent_campaign_id`	number	Parent campaign ID
`client_id`	number	Client ID for agency accounts
`client_name`	string	Client name
`client_email`	string	Client email
`client_company_name`	string	Client company name
`tags`	array	Tags on the record
`email_campaign_id`	number	Campaign the webhook belongs to

Smartlead Add Email Accounts to Campaign

Attaches sending email accounts to a Smartlead campaign. A campaign needs at least one attached account before it can start.

Input

Parameter	Type	Required	Description
`emailAccountIds`	array	Yes	IDs of the email accounts to attach, from List Email Accounts

Output

Parameter	Type	Description
`campaigns`	array	List of campaigns
`leads`	array	List of leads
`sequences`	array	Email sequence steps
`categories`	array	Lead categories
`webhooks`	array	Campaign webhooks
`stats`	array	Per-email statistics rows
`history`	array	Lead message history
`count`	number	Number of records returned
`total_leads`	number	Total leads in the campaign, or leads newly added when importing
`total_stats`	number	Total statistics rows matching the filters
`id`	number	Record ID
`name`	string	Record name
`status`	string	Campaign status
`email`	string	Lead email address
`webhook_url`	string	Webhook destination URL
`event_types`	array	Webhook event types
`sent_count`	number	Emails sent
`open_count`	number	Email opens
`click_count`	number	Link clicks
`reply_count`	number	Replies
`bounce_count`	number	Bounces
`campaign_lead_stats`	json	Lead counts by state
`upload_count`	number	Leads submitted in the request
`success`	boolean	Whether the action succeeded
`items`	array	Records returned by Smartlead
`rows`	array	Rows returned by Smartlead
`lists`	array	Lead lists
`summary`	array	Webhook delivery summary rows
`csv`	string	Exported leads as CSV
`row_count`	number	Rows in the exported CSV
`has_more`	boolean	Whether more rows are available
`list_name`	string	Lead list name
`positive_reply_count`	number	Replies categorized as positive
`offset`	number	Pagination offset used
`limit`	number	Pagination limit used
`total_count`	number	Total records matching the request
`from`	string	Start of the reported window
`to`	string	End of the reported window
`start_date`	string	Start of the reported range
`end_date`	string	End of the reported range
`skipped_count`	number	Emails skipped
`failed_count`	number	Failed sends
`stopped_count`	number	Stopped leads
`unsubscribed_count`	number	Unsubscribes
`unique_sent_count`	number	Unique leads emailed
`unique_open_count`	number	Unique opens
`unique_click_count`	number	Unique clicks
`block_count`	number	Blocked sends, or leads skipped by the block list
`drafted_count`	number	Drafted emails
`sequence_count`	number	Sequence steps in the campaign
`duplicate_count`	number	Duplicate leads skipped on import
`invalid_email_count`	number	Leads skipped for an invalid email
`invalid_emails`	array	Emails rejected as invalid
`already_added_to_campaign`	number	Leads already in the campaign
`unsubscribed_leads`	array	Leads skipped because they unsubscribed
`lead_import_stopped_count`	number	Leads whose import was stopped
`is_lead_limit_exhausted`	boolean	Whether the plan lead limit was hit
`is_last_sequence`	boolean	Whether the lead was on the final step
`next_sequence_id`	number	ID of the next sequence step
`next_sequence_delay_in_days`	number	Days before the next step
`first_name`	string	Lead first name
`last_name`	string	Lead last name
`phone_number`	string	Lead phone number
`company_name`	string	Lead company name
`website`	string	Lead website
`location`	string	Lead location
`linkedin_profile`	string	Lead LinkedIn profile URL
`company_url`	string	Lead company URL
`custom_fields`	json	Lead custom fields
`is_unsubscribed`	boolean	Whether the lead is unsubscribed
`lead_campaign_data`	array	Campaigns the lead belongs to
`created_at`	string	Creation timestamp
`updated_at`	string	Last update timestamp
`leads_count`	number	Leads in the list
`active_leads_count`	number	Active leads in the list
`track_settings`	array	Disabled tracking settings
`scheduler_cron_value`	json	Campaign sending schedule
`accounts`	array	Sending email accounts, excluding their stored mailbox credentials
`user_id`	number	Owning Smartlead user ID
`min_time_btwn_emails`	number	Minimum minutes between emails
`max_leads_per_day`	number	Maximum new leads per day
`stop_lead_settings`	string	Activity that stops a lead sequence
`schedule_start_time`	string	Scheduled start time
`enable_ai_esp_matching`	boolean	Whether AI ESP matching is enabled
`send_as_plain_text`	boolean	Whether emails send as plain text
`follow_up_percentage`	number	Follow-up percentage
`unsubscribe_text`	string	Unsubscribe text
`parent_campaign_id`	number	Parent campaign ID
`client_id`	number	Client ID for agency accounts
`client_name`	string	Client name
`client_email`	string	Client email
`client_company_name`	string	Client company name
`tags`	array	Tags on the record
`email_campaign_id`	number	Campaign the webhook belongs to

Smartlead Remove Email Accounts from Campaign

Detaches sending email accounts from a Smartlead campaign.

Input

Parameter	Type	Required	Description
`emailAccountIds`	array	Yes	IDs of the email accounts to detach

Output

Parameter	Type	Description
`campaigns`	array	List of campaigns
`leads`	array	List of leads
`sequences`	array	Email sequence steps
`categories`	array	Lead categories
`webhooks`	array	Campaign webhooks
`stats`	array	Per-email statistics rows
`history`	array	Lead message history
`count`	number	Number of records returned
`total_leads`	number	Total leads in the campaign, or leads newly added when importing
`total_stats`	number	Total statistics rows matching the filters
`id`	number	Record ID
`name`	string	Record name
`status`	string	Campaign status
`email`	string	Lead email address
`webhook_url`	string	Webhook destination URL
`event_types`	array	Webhook event types
`sent_count`	number	Emails sent
`open_count`	number	Email opens
`click_count`	number	Link clicks
`reply_count`	number	Replies
`bounce_count`	number	Bounces
`campaign_lead_stats`	json	Lead counts by state
`upload_count`	number	Leads submitted in the request
`success`	boolean	Whether the action succeeded
`items`	array	Records returned by Smartlead
`rows`	array	Rows returned by Smartlead
`lists`	array	Lead lists
`summary`	array	Webhook delivery summary rows
`csv`	string	Exported leads as CSV
`row_count`	number	Rows in the exported CSV
`has_more`	boolean	Whether more rows are available
`list_name`	string	Lead list name
`positive_reply_count`	number	Replies categorized as positive
`offset`	number	Pagination offset used
`limit`	number	Pagination limit used
`total_count`	number	Total records matching the request
`from`	string	Start of the reported window
`to`	string	End of the reported window
`start_date`	string	Start of the reported range
`end_date`	string	End of the reported range
`skipped_count`	number	Emails skipped
`failed_count`	number	Failed sends
`stopped_count`	number	Stopped leads
`unsubscribed_count`	number	Unsubscribes
`unique_sent_count`	number	Unique leads emailed
`unique_open_count`	number	Unique opens
`unique_click_count`	number	Unique clicks
`block_count`	number	Blocked sends, or leads skipped by the block list
`drafted_count`	number	Drafted emails
`sequence_count`	number	Sequence steps in the campaign
`duplicate_count`	number	Duplicate leads skipped on import
`invalid_email_count`	number	Leads skipped for an invalid email
`invalid_emails`	array	Emails rejected as invalid
`already_added_to_campaign`	number	Leads already in the campaign
`unsubscribed_leads`	array	Leads skipped because they unsubscribed
`lead_import_stopped_count`	number	Leads whose import was stopped
`is_lead_limit_exhausted`	boolean	Whether the plan lead limit was hit
`is_last_sequence`	boolean	Whether the lead was on the final step
`next_sequence_id`	number	ID of the next sequence step
`next_sequence_delay_in_days`	number	Days before the next step
`first_name`	string	Lead first name
`last_name`	string	Lead last name
`phone_number`	string	Lead phone number
`company_name`	string	Lead company name
`website`	string	Lead website
`location`	string	Lead location
`linkedin_profile`	string	Lead LinkedIn profile URL
`company_url`	string	Lead company URL
`custom_fields`	json	Lead custom fields
`is_unsubscribed`	boolean	Whether the lead is unsubscribed
`lead_campaign_data`	array	Campaigns the lead belongs to
`created_at`	string	Creation timestamp
`updated_at`	string	Last update timestamp
`leads_count`	number	Leads in the list
`active_leads_count`	number	Active leads in the list
`track_settings`	array	Disabled tracking settings
`scheduler_cron_value`	json	Campaign sending schedule
`accounts`	array	Sending email accounts, excluding their stored mailbox credentials
`user_id`	number	Owning Smartlead user ID
`min_time_btwn_emails`	number	Minimum minutes between emails
`max_leads_per_day`	number	Maximum new leads per day
`stop_lead_settings`	string	Activity that stops a lead sequence
`schedule_start_time`	string	Scheduled start time
`enable_ai_esp_matching`	boolean	Whether AI ESP matching is enabled
`send_as_plain_text`	boolean	Whether emails send as plain text
`follow_up_percentage`	number	Follow-up percentage
`unsubscribe_text`	string	Unsubscribe text
`parent_campaign_id`	number	Parent campaign ID
`client_id`	number	Client ID for agency accounts
`client_name`	string	Client name
`client_email`	string	Client email
`client_company_name`	string	Client company name
`tags`	array	Tags on the record
`email_campaign_id`	number	Campaign the webhook belongs to

Smartlead List Email Accounts

Retrieves the sending email accounts on the Smartlead account, including their IDs for attaching to a campaign.

Input

Parameter	Type	Required	Description
`offset`	number	No	Pagination offset (default 0)
`limit`	number	No	Accounts to return per page (default 100)
`clientId`	number	No	Only return accounts for this client (agency accounts)

Output

Parameter	Type	Description
`campaigns`	array	List of campaigns
`leads`	array	List of leads
`sequences`	array	Email sequence steps
`categories`	array	Lead categories
`webhooks`	array	Campaign webhooks
`stats`	array	Per-email statistics rows
`history`	array	Lead message history
`count`	number	Number of records returned
`total_leads`	number	Total leads in the campaign, or leads newly added when importing
`total_stats`	number	Total statistics rows matching the filters
`id`	number	Record ID
`name`	string	Record name
`status`	string	Campaign status
`email`	string	Lead email address
`webhook_url`	string	Webhook destination URL
`event_types`	array	Webhook event types
`sent_count`	number	Emails sent
`open_count`	number	Email opens
`click_count`	number	Link clicks
`reply_count`	number	Replies
`bounce_count`	number	Bounces
`campaign_lead_stats`	json	Lead counts by state
`upload_count`	number	Leads submitted in the request
`success`	boolean	Whether the action succeeded
`items`	array	Records returned by Smartlead
`rows`	array	Rows returned by Smartlead
`lists`	array	Lead lists
`summary`	array	Webhook delivery summary rows
`csv`	string	Exported leads as CSV
`row_count`	number	Rows in the exported CSV
`has_more`	boolean	Whether more rows are available
`list_name`	string	Lead list name
`positive_reply_count`	number	Replies categorized as positive
`offset`	number	Pagination offset used
`limit`	number	Pagination limit used
`total_count`	number	Total records matching the request
`from`	string	Start of the reported window
`to`	string	End of the reported window
`start_date`	string	Start of the reported range
`end_date`	string	End of the reported range
`skipped_count`	number	Emails skipped
`failed_count`	number	Failed sends
`stopped_count`	number	Stopped leads
`unsubscribed_count`	number	Unsubscribes
`unique_sent_count`	number	Unique leads emailed
`unique_open_count`	number	Unique opens
`unique_click_count`	number	Unique clicks
`block_count`	number	Blocked sends, or leads skipped by the block list
`drafted_count`	number	Drafted emails
`sequence_count`	number	Sequence steps in the campaign
`duplicate_count`	number	Duplicate leads skipped on import
`invalid_email_count`	number	Leads skipped for an invalid email
`invalid_emails`	array	Emails rejected as invalid
`already_added_to_campaign`	number	Leads already in the campaign
`unsubscribed_leads`	array	Leads skipped because they unsubscribed
`lead_import_stopped_count`	number	Leads whose import was stopped
`is_lead_limit_exhausted`	boolean	Whether the plan lead limit was hit
`is_last_sequence`	boolean	Whether the lead was on the final step
`next_sequence_id`	number	ID of the next sequence step
`next_sequence_delay_in_days`	number	Days before the next step
`first_name`	string	Lead first name
`last_name`	string	Lead last name
`phone_number`	string	Lead phone number
`company_name`	string	Lead company name
`website`	string	Lead website
`location`	string	Lead location
`linkedin_profile`	string	Lead LinkedIn profile URL
`company_url`	string	Lead company URL
`custom_fields`	json	Lead custom fields
`is_unsubscribed`	boolean	Whether the lead is unsubscribed
`lead_campaign_data`	array	Campaigns the lead belongs to
`created_at`	string	Creation timestamp
`updated_at`	string	Last update timestamp
`leads_count`	number	Leads in the list
`active_leads_count`	number	Active leads in the list
`track_settings`	array	Disabled tracking settings
`scheduler_cron_value`	json	Campaign sending schedule
`accounts`	array	Sending email accounts, excluding their stored mailbox credentials
`user_id`	number	Owning Smartlead user ID
`min_time_btwn_emails`	number	Minimum minutes between emails
`max_leads_per_day`	number	Maximum new leads per day
`stop_lead_settings`	string	Activity that stops a lead sequence
`schedule_start_time`	string	Scheduled start time
`enable_ai_esp_matching`	boolean	Whether AI ESP matching is enabled
`send_as_plain_text`	boolean	Whether emails send as plain text
`follow_up_percentage`	number	Follow-up percentage
`unsubscribe_text`	string	Unsubscribe text
`parent_campaign_id`	number	Parent campaign ID
`client_id`	number	Client ID for agency accounts
`client_name`	string	Client name
`client_email`	string	Client email
`client_company_name`	string	Client company name
`tags`	array	Tags on the record
`email_campaign_id`	number	Campaign the webhook belongs to

Smartlead Get Campaign Lead Statistics

Retrieves per-lead engagement statistics for a Smartlead campaign.

Input

Parameter	Type	Required	Description
`limit`	number	No	Rows to return (default 100)
`offset`	number	No	Rows to skip (default 0)

Output

Parameter	Type	Description
`campaigns`	array	List of campaigns
`leads`	array	List of leads
`sequences`	array	Email sequence steps
`categories`	array	Lead categories
`webhooks`	array	Campaign webhooks
`stats`	array	Per-email statistics rows
`history`	array	Lead message history
`count`	number	Number of records returned
`total_leads`	number	Total leads in the campaign, or leads newly added when importing
`total_stats`	number	Total statistics rows matching the filters
`id`	number	Record ID
`name`	string	Record name
`status`	string	Campaign status
`email`	string	Lead email address
`webhook_url`	string	Webhook destination URL
`event_types`	array	Webhook event types
`sent_count`	number	Emails sent
`open_count`	number	Email opens
`click_count`	number	Link clicks
`reply_count`	number	Replies
`bounce_count`	number	Bounces
`campaign_lead_stats`	json	Lead counts by state
`upload_count`	number	Leads submitted in the request
`success`	boolean	Whether the action succeeded
`items`	array	Records returned by Smartlead
`rows`	array	Rows returned by Smartlead
`lists`	array	Lead lists
`summary`	array	Webhook delivery summary rows
`csv`	string	Exported leads as CSV
`row_count`	number	Rows in the exported CSV
`has_more`	boolean	Whether more rows are available
`list_name`	string	Lead list name
`positive_reply_count`	number	Replies categorized as positive
`offset`	number	Pagination offset used
`limit`	number	Pagination limit used
`total_count`	number	Total records matching the request
`from`	string	Start of the reported window
`to`	string	End of the reported window
`start_date`	string	Start of the reported range
`end_date`	string	End of the reported range
`skipped_count`	number	Emails skipped
`failed_count`	number	Failed sends
`stopped_count`	number	Stopped leads
`unsubscribed_count`	number	Unsubscribes
`unique_sent_count`	number	Unique leads emailed
`unique_open_count`	number	Unique opens
`unique_click_count`	number	Unique clicks
`block_count`	number	Blocked sends, or leads skipped by the block list
`drafted_count`	number	Drafted emails
`sequence_count`	number	Sequence steps in the campaign
`duplicate_count`	number	Duplicate leads skipped on import
`invalid_email_count`	number	Leads skipped for an invalid email
`invalid_emails`	array	Emails rejected as invalid
`already_added_to_campaign`	number	Leads already in the campaign
`unsubscribed_leads`	array	Leads skipped because they unsubscribed
`lead_import_stopped_count`	number	Leads whose import was stopped
`is_lead_limit_exhausted`	boolean	Whether the plan lead limit was hit
`is_last_sequence`	boolean	Whether the lead was on the final step
`next_sequence_id`	number	ID of the next sequence step
`next_sequence_delay_in_days`	number	Days before the next step
`first_name`	string	Lead first name
`last_name`	string	Lead last name
`phone_number`	string	Lead phone number
`company_name`	string	Lead company name
`website`	string	Lead website
`location`	string	Lead location
`linkedin_profile`	string	Lead LinkedIn profile URL
`company_url`	string	Lead company URL
`custom_fields`	json	Lead custom fields
`is_unsubscribed`	boolean	Whether the lead is unsubscribed
`lead_campaign_data`	array	Campaigns the lead belongs to
`created_at`	string	Creation timestamp
`updated_at`	string	Last update timestamp
`leads_count`	number	Leads in the list
`active_leads_count`	number	Active leads in the list
`track_settings`	array	Disabled tracking settings
`scheduler_cron_value`	json	Campaign sending schedule
`accounts`	array	Sending email accounts, excluding their stored mailbox credentials
`user_id`	number	Owning Smartlead user ID
`min_time_btwn_emails`	number	Minimum minutes between emails
`max_leads_per_day`	number	Maximum new leads per day
`stop_lead_settings`	string	Activity that stops a lead sequence
`schedule_start_time`	string	Scheduled start time
`enable_ai_esp_matching`	boolean	Whether AI ESP matching is enabled
`send_as_plain_text`	boolean	Whether emails send as plain text
`follow_up_percentage`	number	Follow-up percentage
`unsubscribe_text`	string	Unsubscribe text
`parent_campaign_id`	number	Parent campaign ID
`client_id`	number	Client ID for agency accounts
`client_name`	string	Client name
`client_email`	string	Client email
`client_company_name`	string	Client company name
`tags`	array	Tags on the record
`email_campaign_id`	number	Campaign the webhook belongs to

Smartlead Get Campaign Mailbox Statistics

Retrieves per-mailbox sending statistics for a Smartlead campaign, for spotting which sending accounts are underperforming.

Input

Parameter	Type	Required	Description

Output

Parameter	Type	Description
`campaigns`	array	List of campaigns
`leads`	array	List of leads
`sequences`	array	Email sequence steps
`categories`	array	Lead categories
`webhooks`	array	Campaign webhooks
`stats`	array	Per-email statistics rows
`history`	array	Lead message history
`count`	number	Number of records returned
`total_leads`	number	Total leads in the campaign, or leads newly added when importing
`total_stats`	number	Total statistics rows matching the filters
`id`	number	Record ID
`name`	string	Record name
`status`	string	Campaign status
`email`	string	Lead email address
`webhook_url`	string	Webhook destination URL
`event_types`	array	Webhook event types
`sent_count`	number	Emails sent
`open_count`	number	Email opens
`click_count`	number	Link clicks
`reply_count`	number	Replies
`bounce_count`	number	Bounces
`campaign_lead_stats`	json	Lead counts by state
`upload_count`	number	Leads submitted in the request
`success`	boolean	Whether the action succeeded
`items`	array	Records returned by Smartlead
`rows`	array	Rows returned by Smartlead
`lists`	array	Lead lists
`summary`	array	Webhook delivery summary rows
`csv`	string	Exported leads as CSV
`row_count`	number	Rows in the exported CSV
`has_more`	boolean	Whether more rows are available
`list_name`	string	Lead list name
`positive_reply_count`	number	Replies categorized as positive
`offset`	number	Pagination offset used
`limit`	number	Pagination limit used
`total_count`	number	Total records matching the request
`from`	string	Start of the reported window
`to`	string	End of the reported window
`start_date`	string	Start of the reported range
`end_date`	string	End of the reported range
`skipped_count`	number	Emails skipped
`failed_count`	number	Failed sends
`stopped_count`	number	Stopped leads
`unsubscribed_count`	number	Unsubscribes
`unique_sent_count`	number	Unique leads emailed
`unique_open_count`	number	Unique opens
`unique_click_count`	number	Unique clicks
`block_count`	number	Blocked sends, or leads skipped by the block list
`drafted_count`	number	Drafted emails
`sequence_count`	number	Sequence steps in the campaign
`duplicate_count`	number	Duplicate leads skipped on import
`invalid_email_count`	number	Leads skipped for an invalid email
`invalid_emails`	array	Emails rejected as invalid
`already_added_to_campaign`	number	Leads already in the campaign
`unsubscribed_leads`	array	Leads skipped because they unsubscribed
`lead_import_stopped_count`	number	Leads whose import was stopped
`is_lead_limit_exhausted`	boolean	Whether the plan lead limit was hit
`is_last_sequence`	boolean	Whether the lead was on the final step
`next_sequence_id`	number	ID of the next sequence step
`next_sequence_delay_in_days`	number	Days before the next step
`first_name`	string	Lead first name
`last_name`	string	Lead last name
`phone_number`	string	Lead phone number
`company_name`	string	Lead company name
`website`	string	Lead website
`location`	string	Lead location
`linkedin_profile`	string	Lead LinkedIn profile URL
`company_url`	string	Lead company URL
`custom_fields`	json	Lead custom fields
`is_unsubscribed`	boolean	Whether the lead is unsubscribed
`lead_campaign_data`	array	Campaigns the lead belongs to
`created_at`	string	Creation timestamp
`updated_at`	string	Last update timestamp
`leads_count`	number	Leads in the list
`active_leads_count`	number	Active leads in the list
`track_settings`	array	Disabled tracking settings
`scheduler_cron_value`	json	Campaign sending schedule
`accounts`	array	Sending email accounts, excluding their stored mailbox credentials
`user_id`	number	Owning Smartlead user ID
`min_time_btwn_emails`	number	Minimum minutes between emails
`max_leads_per_day`	number	Maximum new leads per day
`stop_lead_settings`	string	Activity that stops a lead sequence
`schedule_start_time`	string	Scheduled start time
`enable_ai_esp_matching`	boolean	Whether AI ESP matching is enabled
`send_as_plain_text`	boolean	Whether emails send as plain text
`follow_up_percentage`	number	Follow-up percentage
`unsubscribe_text`	string	Unsubscribe text
`parent_campaign_id`	number	Parent campaign ID
`client_id`	number	Client ID for agency accounts
`client_name`	string	Client name
`client_email`	string	Client email
`client_company_name`	string	Client company name
`tags`	array	Tags on the record
`email_campaign_id`	number	Campaign the webhook belongs to

Smartlead Get Campaign Top-Level Analytics By Date

Retrieves top-level Smartlead campaign counts for a date range, including positive replies, skipped, failed, and stopped counts not present in the standard analytics.

Input

Parameter	Type	Required	Description
`startDate`	string	Yes	Range start date in YYYY-MM-DD format
`endDate`	string	Yes	Range end date in YYYY-MM-DD format

Output

Parameter	Type	Description
`campaigns`	array	List of campaigns
`leads`	array	List of leads
`sequences`	array	Email sequence steps
`categories`	array	Lead categories
`webhooks`	array	Campaign webhooks
`stats`	array	Per-email statistics rows
`history`	array	Lead message history
`count`	number	Number of records returned
`total_leads`	number	Total leads in the campaign, or leads newly added when importing
`total_stats`	number	Total statistics rows matching the filters
`id`	number	Record ID
`name`	string	Record name
`status`	string	Campaign status
`email`	string	Lead email address
`webhook_url`	string	Webhook destination URL
`event_types`	array	Webhook event types
`sent_count`	number	Emails sent
`open_count`	number	Email opens
`click_count`	number	Link clicks
`reply_count`	number	Replies
`bounce_count`	number	Bounces
`campaign_lead_stats`	json	Lead counts by state
`upload_count`	number	Leads submitted in the request
`success`	boolean	Whether the action succeeded
`items`	array	Records returned by Smartlead
`rows`	array	Rows returned by Smartlead
`lists`	array	Lead lists
`summary`	array	Webhook delivery summary rows
`csv`	string	Exported leads as CSV
`row_count`	number	Rows in the exported CSV
`has_more`	boolean	Whether more rows are available
`list_name`	string	Lead list name
`positive_reply_count`	number	Replies categorized as positive
`offset`	number	Pagination offset used
`limit`	number	Pagination limit used
`total_count`	number	Total records matching the request
`from`	string	Start of the reported window
`to`	string	End of the reported window
`start_date`	string	Start of the reported range
`end_date`	string	End of the reported range
`skipped_count`	number	Emails skipped
`failed_count`	number	Failed sends
`stopped_count`	number	Stopped leads
`unsubscribed_count`	number	Unsubscribes
`unique_sent_count`	number	Unique leads emailed
`unique_open_count`	number	Unique opens
`unique_click_count`	number	Unique clicks
`block_count`	number	Blocked sends, or leads skipped by the block list
`drafted_count`	number	Drafted emails
`sequence_count`	number	Sequence steps in the campaign
`duplicate_count`	number	Duplicate leads skipped on import
`invalid_email_count`	number	Leads skipped for an invalid email
`invalid_emails`	array	Emails rejected as invalid
`already_added_to_campaign`	number	Leads already in the campaign
`unsubscribed_leads`	array	Leads skipped because they unsubscribed
`lead_import_stopped_count`	number	Leads whose import was stopped
`is_lead_limit_exhausted`	boolean	Whether the plan lead limit was hit
`is_last_sequence`	boolean	Whether the lead was on the final step
`next_sequence_id`	number	ID of the next sequence step
`next_sequence_delay_in_days`	number	Days before the next step
`first_name`	string	Lead first name
`last_name`	string	Lead last name
`phone_number`	string	Lead phone number
`company_name`	string	Lead company name
`website`	string	Lead website
`location`	string	Lead location
`linkedin_profile`	string	Lead LinkedIn profile URL
`company_url`	string	Lead company URL
`custom_fields`	json	Lead custom fields
`is_unsubscribed`	boolean	Whether the lead is unsubscribed
`lead_campaign_data`	array	Campaigns the lead belongs to
`created_at`	string	Creation timestamp
`updated_at`	string	Last update timestamp
`leads_count`	number	Leads in the list
`active_leads_count`	number	Active leads in the list
`track_settings`	array	Disabled tracking settings
`scheduler_cron_value`	json	Campaign sending schedule
`accounts`	array	Sending email accounts, excluding their stored mailbox credentials
`user_id`	number	Owning Smartlead user ID
`min_time_btwn_emails`	number	Minimum minutes between emails
`max_leads_per_day`	number	Maximum new leads per day
`stop_lead_settings`	string	Activity that stops a lead sequence
`schedule_start_time`	string	Scheduled start time
`enable_ai_esp_matching`	boolean	Whether AI ESP matching is enabled
`send_as_plain_text`	boolean	Whether emails send as plain text
`follow_up_percentage`	number	Follow-up percentage
`unsubscribe_text`	string	Unsubscribe text
`parent_campaign_id`	number	Parent campaign ID
`client_id`	number	Client ID for agency accounts
`client_name`	string	Client name
`client_email`	string	Client email
`client_company_name`	string	Client company name
`tags`	array	Tags on the record
`email_campaign_id`	number	Campaign the webhook belongs to

Smartlead List Lead Activities

Retrieves recent lead activity across all Smartlead campaigns — opens, clicks, replies, and status changes. Smartlead exposes no campaign filter on this endpoint.

Input

Parameter	Type	Required	Description
`offset`	number	No	Pagination offset (default 0)
`limit`	number	No	Rows to return per page

Output

Parameter	Type	Description
`campaigns`	array	List of campaigns
`leads`	array	List of leads
`sequences`	array	Email sequence steps
`categories`	array	Lead categories
`webhooks`	array	Campaign webhooks
`stats`	array	Per-email statistics rows
`history`	array	Lead message history
`count`	number	Number of records returned
`total_leads`	number	Total leads in the campaign, or leads newly added when importing
`total_stats`	number	Total statistics rows matching the filters
`id`	number	Record ID
`name`	string	Record name
`status`	string	Campaign status
`email`	string	Lead email address
`webhook_url`	string	Webhook destination URL
`event_types`	array	Webhook event types
`sent_count`	number	Emails sent
`open_count`	number	Email opens
`click_count`	number	Link clicks
`reply_count`	number	Replies
`bounce_count`	number	Bounces
`campaign_lead_stats`	json	Lead counts by state
`upload_count`	number	Leads submitted in the request
`success`	boolean	Whether the action succeeded
`items`	array	Records returned by Smartlead
`rows`	array	Rows returned by Smartlead
`lists`	array	Lead lists
`summary`	array	Webhook delivery summary rows
`csv`	string	Exported leads as CSV
`row_count`	number	Rows in the exported CSV
`has_more`	boolean	Whether more rows are available
`list_name`	string	Lead list name
`positive_reply_count`	number	Replies categorized as positive
`offset`	number	Pagination offset used
`limit`	number	Pagination limit used
`total_count`	number	Total records matching the request
`from`	string	Start of the reported window
`to`	string	End of the reported window
`start_date`	string	Start of the reported range
`end_date`	string	End of the reported range
`skipped_count`	number	Emails skipped
`failed_count`	number	Failed sends
`stopped_count`	number	Stopped leads
`unsubscribed_count`	number	Unsubscribes
`unique_sent_count`	number	Unique leads emailed
`unique_open_count`	number	Unique opens
`unique_click_count`	number	Unique clicks
`block_count`	number	Blocked sends, or leads skipped by the block list
`drafted_count`	number	Drafted emails
`sequence_count`	number	Sequence steps in the campaign
`duplicate_count`	number	Duplicate leads skipped on import
`invalid_email_count`	number	Leads skipped for an invalid email
`invalid_emails`	array	Emails rejected as invalid
`already_added_to_campaign`	number	Leads already in the campaign
`unsubscribed_leads`	array	Leads skipped because they unsubscribed
`lead_import_stopped_count`	number	Leads whose import was stopped
`is_lead_limit_exhausted`	boolean	Whether the plan lead limit was hit
`is_last_sequence`	boolean	Whether the lead was on the final step
`next_sequence_id`	number	ID of the next sequence step
`next_sequence_delay_in_days`	number	Days before the next step
`first_name`	string	Lead first name
`last_name`	string	Lead last name
`phone_number`	string	Lead phone number
`company_name`	string	Lead company name
`website`	string	Lead website
`location`	string	Lead location
`linkedin_profile`	string	Lead LinkedIn profile URL
`company_url`	string	Lead company URL
`custom_fields`	json	Lead custom fields
`is_unsubscribed`	boolean	Whether the lead is unsubscribed
`lead_campaign_data`	array	Campaigns the lead belongs to
`created_at`	string	Creation timestamp
`updated_at`	string	Last update timestamp
`leads_count`	number	Leads in the list
`active_leads_count`	number	Active leads in the list
`track_settings`	array	Disabled tracking settings
`scheduler_cron_value`	json	Campaign sending schedule
`accounts`	array	Sending email accounts, excluding their stored mailbox credentials
`user_id`	number	Owning Smartlead user ID
`min_time_btwn_emails`	number	Minimum minutes between emails
`max_leads_per_day`	number	Maximum new leads per day
`stop_lead_settings`	string	Activity that stops a lead sequence
`schedule_start_time`	string	Scheduled start time
`enable_ai_esp_matching`	boolean	Whether AI ESP matching is enabled
`send_as_plain_text`	boolean	Whether emails send as plain text
`follow_up_percentage`	number	Follow-up percentage
`unsubscribe_text`	string	Unsubscribe text
`parent_campaign_id`	number	Parent campaign ID
`client_id`	number	Client ID for agency accounts
`client_name`	string	Client name
`client_email`	string	Client email
`client_company_name`	string	Client company name
`tags`	array	Tags on the record
`email_campaign_id`	number	Campaign the webhook belongs to

Smartlead Get Lead by ID

Looks up a Smartlead lead by its ID.

Input

Parameter	Type	Required	Description
`leadId`	number	Yes	Smartlead lead ID — the nested lead.id from List Campaign Leads, NOT campaign_lead_map_id

Output

Parameter	Type	Description
`campaigns`	array	List of campaigns
`leads`	array	List of leads
`sequences`	array	Email sequence steps
`categories`	array	Lead categories
`webhooks`	array	Campaign webhooks
`stats`	array	Per-email statistics rows
`history`	array	Lead message history
`count`	number	Number of records returned
`total_leads`	number	Total leads in the campaign, or leads newly added when importing
`total_stats`	number	Total statistics rows matching the filters
`id`	number	Record ID
`name`	string	Record name
`status`	string	Campaign status
`email`	string	Lead email address
`webhook_url`	string	Webhook destination URL
`event_types`	array	Webhook event types
`sent_count`	number	Emails sent
`open_count`	number	Email opens
`click_count`	number	Link clicks
`reply_count`	number	Replies
`bounce_count`	number	Bounces
`campaign_lead_stats`	json	Lead counts by state
`upload_count`	number	Leads submitted in the request
`success`	boolean	Whether the action succeeded
`items`	array	Records returned by Smartlead
`rows`	array	Rows returned by Smartlead
`lists`	array	Lead lists
`summary`	array	Webhook delivery summary rows
`csv`	string	Exported leads as CSV
`row_count`	number	Rows in the exported CSV
`has_more`	boolean	Whether more rows are available
`list_name`	string	Lead list name
`positive_reply_count`	number	Replies categorized as positive
`offset`	number	Pagination offset used
`limit`	number	Pagination limit used
`total_count`	number	Total records matching the request
`from`	string	Start of the reported window
`to`	string	End of the reported window
`start_date`	string	Start of the reported range
`end_date`	string	End of the reported range
`skipped_count`	number	Emails skipped
`failed_count`	number	Failed sends
`stopped_count`	number	Stopped leads
`unsubscribed_count`	number	Unsubscribes
`unique_sent_count`	number	Unique leads emailed
`unique_open_count`	number	Unique opens
`unique_click_count`	number	Unique clicks
`block_count`	number	Blocked sends, or leads skipped by the block list
`drafted_count`	number	Drafted emails
`sequence_count`	number	Sequence steps in the campaign
`duplicate_count`	number	Duplicate leads skipped on import
`invalid_email_count`	number	Leads skipped for an invalid email
`invalid_emails`	array	Emails rejected as invalid
`already_added_to_campaign`	number	Leads already in the campaign
`unsubscribed_leads`	array	Leads skipped because they unsubscribed
`lead_import_stopped_count`	number	Leads whose import was stopped
`is_lead_limit_exhausted`	boolean	Whether the plan lead limit was hit
`is_last_sequence`	boolean	Whether the lead was on the final step
`next_sequence_id`	number	ID of the next sequence step
`next_sequence_delay_in_days`	number	Days before the next step
`first_name`	string	Lead first name
`last_name`	string	Lead last name
`phone_number`	string	Lead phone number
`company_name`	string	Lead company name
`website`	string	Lead website
`location`	string	Lead location
`linkedin_profile`	string	Lead LinkedIn profile URL
`company_url`	string	Lead company URL
`custom_fields`	json	Lead custom fields
`is_unsubscribed`	boolean	Whether the lead is unsubscribed
`lead_campaign_data`	array	Campaigns the lead belongs to
`created_at`	string	Creation timestamp
`updated_at`	string	Last update timestamp
`leads_count`	number	Leads in the list
`active_leads_count`	number	Active leads in the list
`track_settings`	array	Disabled tracking settings
`scheduler_cron_value`	json	Campaign sending schedule
`accounts`	array	Sending email accounts, excluding their stored mailbox credentials
`user_id`	number	Owning Smartlead user ID
`min_time_btwn_emails`	number	Minimum minutes between emails
`max_leads_per_day`	number	Maximum new leads per day
`stop_lead_settings`	string	Activity that stops a lead sequence
`schedule_start_time`	string	Scheduled start time
`enable_ai_esp_matching`	boolean	Whether AI ESP matching is enabled
`send_as_plain_text`	boolean	Whether emails send as plain text
`follow_up_percentage`	number	Follow-up percentage
`unsubscribe_text`	string	Unsubscribe text
`parent_campaign_id`	number	Parent campaign ID
`client_id`	number	Client ID for agency accounts
`client_name`	string	Client name
`client_email`	string	Client email
`client_company_name`	string	Client company name
`tags`	array	Tags on the record
`email_campaign_id`	number	Campaign the webhook belongs to

Smartlead Unsubscribe Lead from Campaign

Unsubscribes a lead from a single Smartlead campaign, leaving it active in other campaigns.

Input

Parameter	Type	Required	Description

Output

Parameter	Type	Description
`campaigns`	array	List of campaigns
`leads`	array	List of leads
`sequences`	array	Email sequence steps
`categories`	array	Lead categories
`webhooks`	array	Campaign webhooks
`stats`	array	Per-email statistics rows
`history`	array	Lead message history
`count`	number	Number of records returned
`total_leads`	number	Total leads in the campaign, or leads newly added when importing
`total_stats`	number	Total statistics rows matching the filters
`id`	number	Record ID
`name`	string	Record name
`status`	string	Campaign status
`email`	string	Lead email address
`webhook_url`	string	Webhook destination URL
`event_types`	array	Webhook event types
`sent_count`	number	Emails sent
`open_count`	number	Email opens
`click_count`	number	Link clicks
`reply_count`	number	Replies
`bounce_count`	number	Bounces
`campaign_lead_stats`	json	Lead counts by state
`upload_count`	number	Leads submitted in the request
`success`	boolean	Whether the action succeeded
`items`	array	Records returned by Smartlead
`rows`	array	Rows returned by Smartlead
`lists`	array	Lead lists
`summary`	array	Webhook delivery summary rows
`csv`	string	Exported leads as CSV
`row_count`	number	Rows in the exported CSV
`has_more`	boolean	Whether more rows are available
`list_name`	string	Lead list name
`positive_reply_count`	number	Replies categorized as positive
`offset`	number	Pagination offset used
`limit`	number	Pagination limit used
`total_count`	number	Total records matching the request
`from`	string	Start of the reported window
`to`	string	End of the reported window
`start_date`	string	Start of the reported range
`end_date`	string	End of the reported range
`skipped_count`	number	Emails skipped
`failed_count`	number	Failed sends
`stopped_count`	number	Stopped leads
`unsubscribed_count`	number	Unsubscribes
`unique_sent_count`	number	Unique leads emailed
`unique_open_count`	number	Unique opens
`unique_click_count`	number	Unique clicks
`block_count`	number	Blocked sends, or leads skipped by the block list
`drafted_count`	number	Drafted emails
`sequence_count`	number	Sequence steps in the campaign
`duplicate_count`	number	Duplicate leads skipped on import
`invalid_email_count`	number	Leads skipped for an invalid email
`invalid_emails`	array	Emails rejected as invalid
`already_added_to_campaign`	number	Leads already in the campaign
`unsubscribed_leads`	array	Leads skipped because they unsubscribed
`lead_import_stopped_count`	number	Leads whose import was stopped
`is_lead_limit_exhausted`	boolean	Whether the plan lead limit was hit
`is_last_sequence`	boolean	Whether the lead was on the final step
`next_sequence_id`	number	ID of the next sequence step
`next_sequence_delay_in_days`	number	Days before the next step
`first_name`	string	Lead first name
`last_name`	string	Lead last name
`phone_number`	string	Lead phone number
`company_name`	string	Lead company name
`website`	string	Lead website
`location`	string	Lead location
`linkedin_profile`	string	Lead LinkedIn profile URL
`company_url`	string	Lead company URL
`custom_fields`	json	Lead custom fields
`is_unsubscribed`	boolean	Whether the lead is unsubscribed
`lead_campaign_data`	array	Campaigns the lead belongs to
`created_at`	string	Creation timestamp
`updated_at`	string	Last update timestamp
`leads_count`	number	Leads in the list
`active_leads_count`	number	Active leads in the list
`track_settings`	array	Disabled tracking settings
`scheduler_cron_value`	json	Campaign sending schedule
`accounts`	array	Sending email accounts, excluding their stored mailbox credentials
`user_id`	number	Owning Smartlead user ID
`min_time_btwn_emails`	number	Minimum minutes between emails
`max_leads_per_day`	number	Maximum new leads per day
`stop_lead_settings`	string	Activity that stops a lead sequence
`schedule_start_time`	string	Scheduled start time
`enable_ai_esp_matching`	boolean	Whether AI ESP matching is enabled
`send_as_plain_text`	boolean	Whether emails send as plain text
`follow_up_percentage`	number	Follow-up percentage
`unsubscribe_text`	string	Unsubscribe text
`parent_campaign_id`	number	Parent campaign ID
`client_id`	number	Client ID for agency accounts
`client_name`	string	Client name
`client_email`	string	Client email
`client_company_name`	string	Client company name
`tags`	array	Tags on the record
`email_campaign_id`	number	Campaign the webhook belongs to

Smartlead Unsubscribe Lead Globally

Unsubscribes a lead across every Smartlead campaign and adds it to the account-wide unsubscribe list.

Input

Parameter	Type	Required	Description
`leadId`	number	Yes	Smartlead lead ID — the nested lead.id from List Campaign Leads, NOT campaign_lead_map_id

Output

Parameter	Type	Description
`campaigns`	array	List of campaigns
`leads`	array	List of leads
`sequences`	array	Email sequence steps
`categories`	array	Lead categories
`webhooks`	array	Campaign webhooks
`stats`	array	Per-email statistics rows
`history`	array	Lead message history
`count`	number	Number of records returned
`total_leads`	number	Total leads in the campaign, or leads newly added when importing
`total_stats`	number	Total statistics rows matching the filters
`id`	number	Record ID
`name`	string	Record name
`status`	string	Campaign status
`email`	string	Lead email address
`webhook_url`	string	Webhook destination URL
`event_types`	array	Webhook event types
`sent_count`	number	Emails sent
`open_count`	number	Email opens
`click_count`	number	Link clicks
`reply_count`	number	Replies
`bounce_count`	number	Bounces
`campaign_lead_stats`	json	Lead counts by state
`upload_count`	number	Leads submitted in the request
`success`	boolean	Whether the action succeeded
`items`	array	Records returned by Smartlead
`rows`	array	Rows returned by Smartlead
`lists`	array	Lead lists
`summary`	array	Webhook delivery summary rows
`csv`	string	Exported leads as CSV
`row_count`	number	Rows in the exported CSV
`has_more`	boolean	Whether more rows are available
`list_name`	string	Lead list name
`positive_reply_count`	number	Replies categorized as positive
`offset`	number	Pagination offset used
`limit`	number	Pagination limit used
`total_count`	number	Total records matching the request
`from`	string	Start of the reported window
`to`	string	End of the reported window
`start_date`	string	Start of the reported range
`end_date`	string	End of the reported range
`skipped_count`	number	Emails skipped
`failed_count`	number	Failed sends
`stopped_count`	number	Stopped leads
`unsubscribed_count`	number	Unsubscribes
`unique_sent_count`	number	Unique leads emailed
`unique_open_count`	number	Unique opens
`unique_click_count`	number	Unique clicks
`block_count`	number	Blocked sends, or leads skipped by the block list
`drafted_count`	number	Drafted emails
`sequence_count`	number	Sequence steps in the campaign
`duplicate_count`	number	Duplicate leads skipped on import
`invalid_email_count`	number	Leads skipped for an invalid email
`invalid_emails`	array	Emails rejected as invalid
`already_added_to_campaign`	number	Leads already in the campaign
`unsubscribed_leads`	array	Leads skipped because they unsubscribed
`lead_import_stopped_count`	number	Leads whose import was stopped
`is_lead_limit_exhausted`	boolean	Whether the plan lead limit was hit
`is_last_sequence`	boolean	Whether the lead was on the final step
`next_sequence_id`	number	ID of the next sequence step
`next_sequence_delay_in_days`	number	Days before the next step
`first_name`	string	Lead first name
`last_name`	string	Lead last name
`phone_number`	string	Lead phone number
`company_name`	string	Lead company name
`website`	string	Lead website
`location`	string	Lead location
`linkedin_profile`	string	Lead LinkedIn profile URL
`company_url`	string	Lead company URL
`custom_fields`	json	Lead custom fields
`is_unsubscribed`	boolean	Whether the lead is unsubscribed
`lead_campaign_data`	array	Campaigns the lead belongs to
`created_at`	string	Creation timestamp
`updated_at`	string	Last update timestamp
`leads_count`	number	Leads in the list
`active_leads_count`	number	Active leads in the list
`track_settings`	array	Disabled tracking settings
`scheduler_cron_value`	json	Campaign sending schedule
`accounts`	array	Sending email accounts, excluding their stored mailbox credentials
`user_id`	number	Owning Smartlead user ID
`min_time_btwn_emails`	number	Minimum minutes between emails
`max_leads_per_day`	number	Maximum new leads per day
`stop_lead_settings`	string	Activity that stops a lead sequence
`schedule_start_time`	string	Scheduled start time
`enable_ai_esp_matching`	boolean	Whether AI ESP matching is enabled
`send_as_plain_text`	boolean	Whether emails send as plain text
`follow_up_percentage`	number	Follow-up percentage
`unsubscribe_text`	string	Unsubscribe text
`parent_campaign_id`	number	Parent campaign ID
`client_id`	number	Client ID for agency accounts
`client_name`	string	Client name
`client_email`	string	Client email
`client_company_name`	string	Client company name
`tags`	array	Tags on the record
`email_campaign_id`	number	Campaign the webhook belongs to

Smartlead Mark Lead Complete

Marks a lead as completed in a Smartlead campaign so it stops receiving further sequence steps.

Input

Parameter	Type	Required	Description
`campaignLeadMapId`	number	Yes	The campaign_lead_map_id from List Campaign Leads — this endpoint takes the map ID, NOT lead.id

Output

Parameter	Type	Description
`campaigns`	array	List of campaigns
`leads`	array	List of leads
`sequences`	array	Email sequence steps
`categories`	array	Lead categories
`webhooks`	array	Campaign webhooks
`stats`	array	Per-email statistics rows
`history`	array	Lead message history
`count`	number	Number of records returned
`total_leads`	number	Total leads in the campaign, or leads newly added when importing
`total_stats`	number	Total statistics rows matching the filters
`id`	number	Record ID
`name`	string	Record name
`status`	string	Campaign status
`email`	string	Lead email address
`webhook_url`	string	Webhook destination URL
`event_types`	array	Webhook event types
`sent_count`	number	Emails sent
`open_count`	number	Email opens
`click_count`	number	Link clicks
`reply_count`	number	Replies
`bounce_count`	number	Bounces
`campaign_lead_stats`	json	Lead counts by state
`upload_count`	number	Leads submitted in the request
`success`	boolean	Whether the action succeeded
`items`	array	Records returned by Smartlead
`rows`	array	Rows returned by Smartlead
`lists`	array	Lead lists
`summary`	array	Webhook delivery summary rows
`csv`	string	Exported leads as CSV
`row_count`	number	Rows in the exported CSV
`has_more`	boolean	Whether more rows are available
`list_name`	string	Lead list name
`positive_reply_count`	number	Replies categorized as positive
`offset`	number	Pagination offset used
`limit`	number	Pagination limit used
`total_count`	number	Total records matching the request
`from`	string	Start of the reported window
`to`	string	End of the reported window
`start_date`	string	Start of the reported range
`end_date`	string	End of the reported range
`skipped_count`	number	Emails skipped
`failed_count`	number	Failed sends
`stopped_count`	number	Stopped leads
`unsubscribed_count`	number	Unsubscribes
`unique_sent_count`	number	Unique leads emailed
`unique_open_count`	number	Unique opens
`unique_click_count`	number	Unique clicks
`block_count`	number	Blocked sends, or leads skipped by the block list
`drafted_count`	number	Drafted emails
`sequence_count`	number	Sequence steps in the campaign
`duplicate_count`	number	Duplicate leads skipped on import
`invalid_email_count`	number	Leads skipped for an invalid email
`invalid_emails`	array	Emails rejected as invalid
`already_added_to_campaign`	number	Leads already in the campaign
`unsubscribed_leads`	array	Leads skipped because they unsubscribed
`lead_import_stopped_count`	number	Leads whose import was stopped
`is_lead_limit_exhausted`	boolean	Whether the plan lead limit was hit
`is_last_sequence`	boolean	Whether the lead was on the final step
`next_sequence_id`	number	ID of the next sequence step
`next_sequence_delay_in_days`	number	Days before the next step
`first_name`	string	Lead first name
`last_name`	string	Lead last name
`phone_number`	string	Lead phone number
`company_name`	string	Lead company name
`website`	string	Lead website
`location`	string	Lead location
`linkedin_profile`	string	Lead LinkedIn profile URL
`company_url`	string	Lead company URL
`custom_fields`	json	Lead custom fields
`is_unsubscribed`	boolean	Whether the lead is unsubscribed
`lead_campaign_data`	array	Campaigns the lead belongs to
`created_at`	string	Creation timestamp
`updated_at`	string	Last update timestamp
`leads_count`	number	Leads in the list
`active_leads_count`	number	Active leads in the list
`track_settings`	array	Disabled tracking settings
`scheduler_cron_value`	json	Campaign sending schedule
`accounts`	array	Sending email accounts, excluding their stored mailbox credentials
`user_id`	number	Owning Smartlead user ID
`min_time_btwn_emails`	number	Minimum minutes between emails
`max_leads_per_day`	number	Maximum new leads per day
`stop_lead_settings`	string	Activity that stops a lead sequence
`schedule_start_time`	string	Scheduled start time
`enable_ai_esp_matching`	boolean	Whether AI ESP matching is enabled
`send_as_plain_text`	boolean	Whether emails send as plain text
`follow_up_percentage`	number	Follow-up percentage
`unsubscribe_text`	string	Unsubscribe text
`parent_campaign_id`	number	Parent campaign ID
`client_id`	number	Client ID for agency accounts
`client_name`	string	Client name
`client_email`	string	Client email
`client_company_name`	string	Client company name
`tags`	array	Tags on the record
`email_campaign_id`	number	Campaign the webhook belongs to

Smartlead Delete Lead from Campaign

Removes a lead from a Smartlead campaign. The lead record itself remains on the account.

Input

Parameter	Type	Required	Description

Output

Parameter	Type	Description
`campaigns`	array	List of campaigns
`leads`	array	List of leads
`sequences`	array	Email sequence steps
`categories`	array	Lead categories
`webhooks`	array	Campaign webhooks
`stats`	array	Per-email statistics rows
`history`	array	Lead message history
`count`	number	Number of records returned
`total_leads`	number	Total leads in the campaign, or leads newly added when importing
`total_stats`	number	Total statistics rows matching the filters
`id`	number	Record ID
`name`	string	Record name
`status`	string	Campaign status
`email`	string	Lead email address
`webhook_url`	string	Webhook destination URL
`event_types`	array	Webhook event types
`sent_count`	number	Emails sent
`open_count`	number	Email opens
`click_count`	number	Link clicks
`reply_count`	number	Replies
`bounce_count`	number	Bounces
`campaign_lead_stats`	json	Lead counts by state
`upload_count`	number	Leads submitted in the request
`success`	boolean	Whether the action succeeded
`items`	array	Records returned by Smartlead
`rows`	array	Rows returned by Smartlead
`lists`	array	Lead lists
`summary`	array	Webhook delivery summary rows
`csv`	string	Exported leads as CSV
`row_count`	number	Rows in the exported CSV
`has_more`	boolean	Whether more rows are available
`list_name`	string	Lead list name
`positive_reply_count`	number	Replies categorized as positive
`offset`	number	Pagination offset used
`limit`	number	Pagination limit used
`total_count`	number	Total records matching the request
`from`	string	Start of the reported window
`to`	string	End of the reported window
`start_date`	string	Start of the reported range
`end_date`	string	End of the reported range
`skipped_count`	number	Emails skipped
`failed_count`	number	Failed sends
`stopped_count`	number	Stopped leads
`unsubscribed_count`	number	Unsubscribes
`unique_sent_count`	number	Unique leads emailed
`unique_open_count`	number	Unique opens
`unique_click_count`	number	Unique clicks
`block_count`	number	Blocked sends, or leads skipped by the block list
`drafted_count`	number	Drafted emails
`sequence_count`	number	Sequence steps in the campaign
`duplicate_count`	number	Duplicate leads skipped on import
`invalid_email_count`	number	Leads skipped for an invalid email
`invalid_emails`	array	Emails rejected as invalid
`already_added_to_campaign`	number	Leads already in the campaign
`unsubscribed_leads`	array	Leads skipped because they unsubscribed
`lead_import_stopped_count`	number	Leads whose import was stopped
`is_lead_limit_exhausted`	boolean	Whether the plan lead limit was hit
`is_last_sequence`	boolean	Whether the lead was on the final step
`next_sequence_id`	number	ID of the next sequence step
`next_sequence_delay_in_days`	number	Days before the next step
`first_name`	string	Lead first name
`last_name`	string	Lead last name
`phone_number`	string	Lead phone number
`company_name`	string	Lead company name
`website`	string	Lead website
`location`	string	Lead location
`linkedin_profile`	string	Lead LinkedIn profile URL
`company_url`	string	Lead company URL
`custom_fields`	json	Lead custom fields
`is_unsubscribed`	boolean	Whether the lead is unsubscribed
`lead_campaign_data`	array	Campaigns the lead belongs to
`created_at`	string	Creation timestamp
`updated_at`	string	Last update timestamp
`leads_count`	number	Leads in the list
`active_leads_count`	number	Active leads in the list
`track_settings`	array	Disabled tracking settings
`scheduler_cron_value`	json	Campaign sending schedule
`accounts`	array	Sending email accounts, excluding their stored mailbox credentials
`user_id`	number	Owning Smartlead user ID
`min_time_btwn_emails`	number	Minimum minutes between emails
`max_leads_per_day`	number	Maximum new leads per day
`stop_lead_settings`	string	Activity that stops a lead sequence
`schedule_start_time`	string	Scheduled start time
`enable_ai_esp_matching`	boolean	Whether AI ESP matching is enabled
`send_as_plain_text`	boolean	Whether emails send as plain text
`follow_up_percentage`	number	Follow-up percentage
`unsubscribe_text`	string	Unsubscribe text
`parent_campaign_id`	number	Parent campaign ID
`client_id`	number	Client ID for agency accounts
`client_name`	string	Client name
`client_email`	string	Client email
`client_company_name`	string	Client company name
`tags`	array	Tags on the record
`email_campaign_id`	number	Campaign the webhook belongs to

Smartlead List Inbox Replies

Retrieves replies from the Smartlead master inbox across all campaigns, optionally limited to unread replies. Smartlead exposes no campaign filter on this endpoint.

Input

Parameter	Type	Required	Description
`unreadOnly`	boolean	No	Return only unread replies
`offset`	number	No	Pagination offset (default 0)
`limit`	number	No	Replies to return per page

Output

Parameter	Type	Description
`campaigns`	array	List of campaigns
`leads`	array	List of leads
`sequences`	array	Email sequence steps
`categories`	array	Lead categories
`webhooks`	array	Campaign webhooks
`stats`	array	Per-email statistics rows
`history`	array	Lead message history
`count`	number	Number of records returned
`total_leads`	number	Total leads in the campaign, or leads newly added when importing
`total_stats`	number	Total statistics rows matching the filters
`id`	number	Record ID
`name`	string	Record name
`status`	string	Campaign status
`email`	string	Lead email address
`webhook_url`	string	Webhook destination URL
`event_types`	array	Webhook event types
`sent_count`	number	Emails sent
`open_count`	number	Email opens
`click_count`	number	Link clicks
`reply_count`	number	Replies
`bounce_count`	number	Bounces
`campaign_lead_stats`	json	Lead counts by state
`upload_count`	number	Leads submitted in the request
`success`	boolean	Whether the action succeeded
`items`	array	Records returned by Smartlead
`rows`	array	Rows returned by Smartlead
`lists`	array	Lead lists
`summary`	array	Webhook delivery summary rows
`csv`	string	Exported leads as CSV
`row_count`	number	Rows in the exported CSV
`has_more`	boolean	Whether more rows are available
`list_name`	string	Lead list name
`positive_reply_count`	number	Replies categorized as positive
`offset`	number	Pagination offset used
`limit`	number	Pagination limit used
`total_count`	number	Total records matching the request
`from`	string	Start of the reported window
`to`	string	End of the reported window
`start_date`	string	Start of the reported range
`end_date`	string	End of the reported range
`skipped_count`	number	Emails skipped
`failed_count`	number	Failed sends
`stopped_count`	number	Stopped leads
`unsubscribed_count`	number	Unsubscribes
`unique_sent_count`	number	Unique leads emailed
`unique_open_count`	number	Unique opens
`unique_click_count`	number	Unique clicks
`block_count`	number	Blocked sends, or leads skipped by the block list
`drafted_count`	number	Drafted emails
`sequence_count`	number	Sequence steps in the campaign
`duplicate_count`	number	Duplicate leads skipped on import
`invalid_email_count`	number	Leads skipped for an invalid email
`invalid_emails`	array	Emails rejected as invalid
`already_added_to_campaign`	number	Leads already in the campaign
`unsubscribed_leads`	array	Leads skipped because they unsubscribed
`lead_import_stopped_count`	number	Leads whose import was stopped
`is_lead_limit_exhausted`	boolean	Whether the plan lead limit was hit
`is_last_sequence`	boolean	Whether the lead was on the final step
`next_sequence_id`	number	ID of the next sequence step
`next_sequence_delay_in_days`	number	Days before the next step
`first_name`	string	Lead first name
`last_name`	string	Lead last name
`phone_number`	string	Lead phone number
`company_name`	string	Lead company name
`website`	string	Lead website
`location`	string	Lead location
`linkedin_profile`	string	Lead LinkedIn profile URL
`company_url`	string	Lead company URL
`custom_fields`	json	Lead custom fields
`is_unsubscribed`	boolean	Whether the lead is unsubscribed
`lead_campaign_data`	array	Campaigns the lead belongs to
`created_at`	string	Creation timestamp
`updated_at`	string	Last update timestamp
`leads_count`	number	Leads in the list
`active_leads_count`	number	Active leads in the list
`track_settings`	array	Disabled tracking settings
`scheduler_cron_value`	json	Campaign sending schedule
`accounts`	array	Sending email accounts, excluding their stored mailbox credentials
`user_id`	number	Owning Smartlead user ID
`min_time_btwn_emails`	number	Minimum minutes between emails
`max_leads_per_day`	number	Maximum new leads per day
`stop_lead_settings`	string	Activity that stops a lead sequence
`schedule_start_time`	string	Scheduled start time
`enable_ai_esp_matching`	boolean	Whether AI ESP matching is enabled
`send_as_plain_text`	boolean	Whether emails send as plain text
`follow_up_percentage`	number	Follow-up percentage
`unsubscribe_text`	string	Unsubscribe text
`parent_campaign_id`	number	Parent campaign ID
`client_id`	number	Client ID for agency accounts
`client_name`	string	Client name
`client_email`	string	Client email
`client_company_name`	string	Client company name
`tags`	array	Tags on the record
`email_campaign_id`	number	Campaign the webhook belongs to

Smartlead List Lead Lists

Retrieves the lead lists on the Smartlead account with their lead counts.

Input

Parameter	Type	Required	Description
`offset`	number	No	Pagination offset (default 0)
`limit`	number	No	Lists to return per page

Output

Parameter	Type	Description
`campaigns`	array	List of campaigns
`leads`	array	List of leads
`sequences`	array	Email sequence steps
`categories`	array	Lead categories
`webhooks`	array	Campaign webhooks
`stats`	array	Per-email statistics rows
`history`	array	Lead message history
`count`	number	Number of records returned
`total_leads`	number	Total leads in the campaign, or leads newly added when importing
`total_stats`	number	Total statistics rows matching the filters
`id`	number	Record ID
`name`	string	Record name
`status`	string	Campaign status
`email`	string	Lead email address
`webhook_url`	string	Webhook destination URL
`event_types`	array	Webhook event types
`sent_count`	number	Emails sent
`open_count`	number	Email opens
`click_count`	number	Link clicks
`reply_count`	number	Replies
`bounce_count`	number	Bounces
`campaign_lead_stats`	json	Lead counts by state
`upload_count`	number	Leads submitted in the request
`success`	boolean	Whether the action succeeded
`items`	array	Records returned by Smartlead
`rows`	array	Rows returned by Smartlead
`lists`	array	Lead lists
`summary`	array	Webhook delivery summary rows
`csv`	string	Exported leads as CSV
`row_count`	number	Rows in the exported CSV
`has_more`	boolean	Whether more rows are available
`list_name`	string	Lead list name
`positive_reply_count`	number	Replies categorized as positive
`offset`	number	Pagination offset used
`limit`	number	Pagination limit used
`total_count`	number	Total records matching the request
`from`	string	Start of the reported window
`to`	string	End of the reported window
`start_date`	string	Start of the reported range
`end_date`	string	End of the reported range
`skipped_count`	number	Emails skipped
`failed_count`	number	Failed sends
`stopped_count`	number	Stopped leads
`unsubscribed_count`	number	Unsubscribes
`unique_sent_count`	number	Unique leads emailed
`unique_open_count`	number	Unique opens
`unique_click_count`	number	Unique clicks
`block_count`	number	Blocked sends, or leads skipped by the block list
`drafted_count`	number	Drafted emails
`sequence_count`	number	Sequence steps in the campaign
`duplicate_count`	number	Duplicate leads skipped on import
`invalid_email_count`	number	Leads skipped for an invalid email
`invalid_emails`	array	Emails rejected as invalid
`already_added_to_campaign`	number	Leads already in the campaign
`unsubscribed_leads`	array	Leads skipped because they unsubscribed
`lead_import_stopped_count`	number	Leads whose import was stopped
`is_lead_limit_exhausted`	boolean	Whether the plan lead limit was hit
`is_last_sequence`	boolean	Whether the lead was on the final step
`next_sequence_id`	number	ID of the next sequence step
`next_sequence_delay_in_days`	number	Days before the next step
`first_name`	string	Lead first name
`last_name`	string	Lead last name
`phone_number`	string	Lead phone number
`company_name`	string	Lead company name
`website`	string	Lead website
`location`	string	Lead location
`linkedin_profile`	string	Lead LinkedIn profile URL
`company_url`	string	Lead company URL
`custom_fields`	json	Lead custom fields
`is_unsubscribed`	boolean	Whether the lead is unsubscribed
`lead_campaign_data`	array	Campaigns the lead belongs to
`created_at`	string	Creation timestamp
`updated_at`	string	Last update timestamp
`leads_count`	number	Leads in the list
`active_leads_count`	number	Active leads in the list
`track_settings`	array	Disabled tracking settings
`scheduler_cron_value`	json	Campaign sending schedule
`accounts`	array	Sending email accounts, excluding their stored mailbox credentials
`user_id`	number	Owning Smartlead user ID
`min_time_btwn_emails`	number	Minimum minutes between emails
`max_leads_per_day`	number	Maximum new leads per day
`stop_lead_settings`	string	Activity that stops a lead sequence
`schedule_start_time`	string	Scheduled start time
`enable_ai_esp_matching`	boolean	Whether AI ESP matching is enabled
`send_as_plain_text`	boolean	Whether emails send as plain text
`follow_up_percentage`	number	Follow-up percentage
`unsubscribe_text`	string	Unsubscribe text
`parent_campaign_id`	number	Parent campaign ID
`client_id`	number	Client ID for agency accounts
`client_name`	string	Client name
`client_email`	string	Client email
`client_company_name`	string	Client company name
`tags`	array	Tags on the record
`email_campaign_id`	number	Campaign the webhook belongs to

Smartlead Get Lead List

Retrieves a single Smartlead lead list by ID.

Input

Parameter	Type	Required	Description
`leadListId`	number	Yes	Lead list ID

Output

Parameter	Type	Description
`campaigns`	array	List of campaigns
`leads`	array	List of leads
`sequences`	array	Email sequence steps
`categories`	array	Lead categories
`webhooks`	array	Campaign webhooks
`stats`	array	Per-email statistics rows
`history`	array	Lead message history
`count`	number	Number of records returned
`total_leads`	number	Total leads in the campaign, or leads newly added when importing
`total_stats`	number	Total statistics rows matching the filters
`id`	number	Record ID
`name`	string	Record name
`status`	string	Campaign status
`email`	string	Lead email address
`webhook_url`	string	Webhook destination URL
`event_types`	array	Webhook event types
`sent_count`	number	Emails sent
`open_count`	number	Email opens
`click_count`	number	Link clicks
`reply_count`	number	Replies
`bounce_count`	number	Bounces
`campaign_lead_stats`	json	Lead counts by state
`upload_count`	number	Leads submitted in the request
`success`	boolean	Whether the action succeeded
`items`	array	Records returned by Smartlead
`rows`	array	Rows returned by Smartlead
`lists`	array	Lead lists
`summary`	array	Webhook delivery summary rows
`csv`	string	Exported leads as CSV
`row_count`	number	Rows in the exported CSV
`has_more`	boolean	Whether more rows are available
`list_name`	string	Lead list name
`positive_reply_count`	number	Replies categorized as positive
`offset`	number	Pagination offset used
`limit`	number	Pagination limit used
`total_count`	number	Total records matching the request
`from`	string	Start of the reported window
`to`	string	End of the reported window
`start_date`	string	Start of the reported range
`end_date`	string	End of the reported range
`skipped_count`	number	Emails skipped
`failed_count`	number	Failed sends
`stopped_count`	number	Stopped leads
`unsubscribed_count`	number	Unsubscribes
`unique_sent_count`	number	Unique leads emailed
`unique_open_count`	number	Unique opens
`unique_click_count`	number	Unique clicks
`block_count`	number	Blocked sends, or leads skipped by the block list
`drafted_count`	number	Drafted emails
`sequence_count`	number	Sequence steps in the campaign
`duplicate_count`	number	Duplicate leads skipped on import
`invalid_email_count`	number	Leads skipped for an invalid email
`invalid_emails`	array	Emails rejected as invalid
`already_added_to_campaign`	number	Leads already in the campaign
`unsubscribed_leads`	array	Leads skipped because they unsubscribed
`lead_import_stopped_count`	number	Leads whose import was stopped
`is_lead_limit_exhausted`	boolean	Whether the plan lead limit was hit
`is_last_sequence`	boolean	Whether the lead was on the final step
`next_sequence_id`	number	ID of the next sequence step
`next_sequence_delay_in_days`	number	Days before the next step
`first_name`	string	Lead first name
`last_name`	string	Lead last name
`phone_number`	string	Lead phone number
`company_name`	string	Lead company name
`website`	string	Lead website
`location`	string	Lead location
`linkedin_profile`	string	Lead LinkedIn profile URL
`company_url`	string	Lead company URL
`custom_fields`	json	Lead custom fields
`is_unsubscribed`	boolean	Whether the lead is unsubscribed
`lead_campaign_data`	array	Campaigns the lead belongs to
`created_at`	string	Creation timestamp
`updated_at`	string	Last update timestamp
`leads_count`	number	Leads in the list
`active_leads_count`	number	Active leads in the list
`track_settings`	array	Disabled tracking settings
`scheduler_cron_value`	json	Campaign sending schedule
`accounts`	array	Sending email accounts, excluding their stored mailbox credentials
`user_id`	number	Owning Smartlead user ID
`min_time_btwn_emails`	number	Minimum minutes between emails
`max_leads_per_day`	number	Maximum new leads per day
`stop_lead_settings`	string	Activity that stops a lead sequence
`schedule_start_time`	string	Scheduled start time
`enable_ai_esp_matching`	boolean	Whether AI ESP matching is enabled
`send_as_plain_text`	boolean	Whether emails send as plain text
`follow_up_percentage`	number	Follow-up percentage
`unsubscribe_text`	string	Unsubscribe text
`parent_campaign_id`	number	Parent campaign ID
`client_id`	number	Client ID for agency accounts
`client_name`	string	Client name
`client_email`	string	Client email
`client_company_name`	string	Client company name
`tags`	array	Tags on the record
`email_campaign_id`	number	Campaign the webhook belongs to

Smartlead Create Lead List

Creates a lead list on the Smartlead account.

Input

Parameter	Type	Required	Description
`listName`	string	Yes	Name for the new lead list

Output

Parameter	Type	Description
`campaigns`	array	List of campaigns
`leads`	array	List of leads
`sequences`	array	Email sequence steps
`categories`	array	Lead categories
`webhooks`	array	Campaign webhooks
`stats`	array	Per-email statistics rows
`history`	array	Lead message history
`count`	number	Number of records returned
`total_leads`	number	Total leads in the campaign, or leads newly added when importing
`total_stats`	number	Total statistics rows matching the filters
`id`	number	Record ID
`name`	string	Record name
`status`	string	Campaign status
`email`	string	Lead email address
`webhook_url`	string	Webhook destination URL
`event_types`	array	Webhook event types
`sent_count`	number	Emails sent
`open_count`	number	Email opens
`click_count`	number	Link clicks
`reply_count`	number	Replies
`bounce_count`	number	Bounces
`campaign_lead_stats`	json	Lead counts by state
`upload_count`	number	Leads submitted in the request
`success`	boolean	Whether the action succeeded
`items`	array	Records returned by Smartlead
`rows`	array	Rows returned by Smartlead
`lists`	array	Lead lists
`summary`	array	Webhook delivery summary rows
`csv`	string	Exported leads as CSV
`row_count`	number	Rows in the exported CSV
`has_more`	boolean	Whether more rows are available
`list_name`	string	Lead list name
`positive_reply_count`	number	Replies categorized as positive
`offset`	number	Pagination offset used
`limit`	number	Pagination limit used
`total_count`	number	Total records matching the request
`from`	string	Start of the reported window
`to`	string	End of the reported window
`start_date`	string	Start of the reported range
`end_date`	string	End of the reported range
`skipped_count`	number	Emails skipped
`failed_count`	number	Failed sends
`stopped_count`	number	Stopped leads
`unsubscribed_count`	number	Unsubscribes
`unique_sent_count`	number	Unique leads emailed
`unique_open_count`	number	Unique opens
`unique_click_count`	number	Unique clicks
`block_count`	number	Blocked sends, or leads skipped by the block list
`drafted_count`	number	Drafted emails
`sequence_count`	number	Sequence steps in the campaign
`duplicate_count`	number	Duplicate leads skipped on import
`invalid_email_count`	number	Leads skipped for an invalid email
`invalid_emails`	array	Emails rejected as invalid
`already_added_to_campaign`	number	Leads already in the campaign
`unsubscribed_leads`	array	Leads skipped because they unsubscribed
`lead_import_stopped_count`	number	Leads whose import was stopped
`is_lead_limit_exhausted`	boolean	Whether the plan lead limit was hit
`is_last_sequence`	boolean	Whether the lead was on the final step
`next_sequence_id`	number	ID of the next sequence step
`next_sequence_delay_in_days`	number	Days before the next step
`first_name`	string	Lead first name
`last_name`	string	Lead last name
`phone_number`	string	Lead phone number
`company_name`	string	Lead company name
`website`	string	Lead website
`location`	string	Lead location
`linkedin_profile`	string	Lead LinkedIn profile URL
`company_url`	string	Lead company URL
`custom_fields`	json	Lead custom fields
`is_unsubscribed`	boolean	Whether the lead is unsubscribed
`lead_campaign_data`	array	Campaigns the lead belongs to
`created_at`	string	Creation timestamp
`updated_at`	string	Last update timestamp
`leads_count`	number	Leads in the list
`active_leads_count`	number	Active leads in the list
`track_settings`	array	Disabled tracking settings
`scheduler_cron_value`	json	Campaign sending schedule
`accounts`	array	Sending email accounts, excluding their stored mailbox credentials
`user_id`	number	Owning Smartlead user ID
`min_time_btwn_emails`	number	Minimum minutes between emails
`max_leads_per_day`	number	Maximum new leads per day
`stop_lead_settings`	string	Activity that stops a lead sequence
`schedule_start_time`	string	Scheduled start time
`enable_ai_esp_matching`	boolean	Whether AI ESP matching is enabled
`send_as_plain_text`	boolean	Whether emails send as plain text
`follow_up_percentage`	number	Follow-up percentage
`unsubscribe_text`	string	Unsubscribe text
`parent_campaign_id`	number	Parent campaign ID
`client_id`	number	Client ID for agency accounts
`client_name`	string	Client name
`client_email`	string	Client email
`client_company_name`	string	Client company name
`tags`	array	Tags on the record
`email_campaign_id`	number	Campaign the webhook belongs to

Smartlead Update Lead List

Renames a Smartlead lead list.

Input

Parameter	Type	Required	Description
`leadListId`	number	Yes	Lead list ID to update
`listName`	string	Yes	New name for the lead list

Output

Parameter	Type	Description
`campaigns`	array	List of campaigns
`leads`	array	List of leads
`sequences`	array	Email sequence steps
`categories`	array	Lead categories
`webhooks`	array	Campaign webhooks
`stats`	array	Per-email statistics rows
`history`	array	Lead message history
`count`	number	Number of records returned
`total_leads`	number	Total leads in the campaign, or leads newly added when importing
`total_stats`	number	Total statistics rows matching the filters
`id`	number	Record ID
`name`	string	Record name
`status`	string	Campaign status
`email`	string	Lead email address
`webhook_url`	string	Webhook destination URL
`event_types`	array	Webhook event types
`sent_count`	number	Emails sent
`open_count`	number	Email opens
`click_count`	number	Link clicks
`reply_count`	number	Replies
`bounce_count`	number	Bounces
`campaign_lead_stats`	json	Lead counts by state
`upload_count`	number	Leads submitted in the request
`success`	boolean	Whether the action succeeded
`items`	array	Records returned by Smartlead
`rows`	array	Rows returned by Smartlead
`lists`	array	Lead lists
`summary`	array	Webhook delivery summary rows
`csv`	string	Exported leads as CSV
`row_count`	number	Rows in the exported CSV
`has_more`	boolean	Whether more rows are available
`list_name`	string	Lead list name
`positive_reply_count`	number	Replies categorized as positive
`offset`	number	Pagination offset used
`limit`	number	Pagination limit used
`total_count`	number	Total records matching the request
`from`	string	Start of the reported window
`to`	string	End of the reported window
`start_date`	string	Start of the reported range
`end_date`	string	End of the reported range
`skipped_count`	number	Emails skipped
`failed_count`	number	Failed sends
`stopped_count`	number	Stopped leads
`unsubscribed_count`	number	Unsubscribes
`unique_sent_count`	number	Unique leads emailed
`unique_open_count`	number	Unique opens
`unique_click_count`	number	Unique clicks
`block_count`	number	Blocked sends, or leads skipped by the block list
`drafted_count`	number	Drafted emails
`sequence_count`	number	Sequence steps in the campaign
`duplicate_count`	number	Duplicate leads skipped on import
`invalid_email_count`	number	Leads skipped for an invalid email
`invalid_emails`	array	Emails rejected as invalid
`already_added_to_campaign`	number	Leads already in the campaign
`unsubscribed_leads`	array	Leads skipped because they unsubscribed
`lead_import_stopped_count`	number	Leads whose import was stopped
`is_lead_limit_exhausted`	boolean	Whether the plan lead limit was hit
`is_last_sequence`	boolean	Whether the lead was on the final step
`next_sequence_id`	number	ID of the next sequence step
`next_sequence_delay_in_days`	number	Days before the next step
`first_name`	string	Lead first name
`last_name`	string	Lead last name
`phone_number`	string	Lead phone number
`company_name`	string	Lead company name
`website`	string	Lead website
`location`	string	Lead location
`linkedin_profile`	string	Lead LinkedIn profile URL
`company_url`	string	Lead company URL
`custom_fields`	json	Lead custom fields
`is_unsubscribed`	boolean	Whether the lead is unsubscribed
`lead_campaign_data`	array	Campaigns the lead belongs to
`created_at`	string	Creation timestamp
`updated_at`	string	Last update timestamp
`leads_count`	number	Leads in the list
`active_leads_count`	number	Active leads in the list
`track_settings`	array	Disabled tracking settings
`scheduler_cron_value`	json	Campaign sending schedule
`accounts`	array	Sending email accounts, excluding their stored mailbox credentials
`user_id`	number	Owning Smartlead user ID
`min_time_btwn_emails`	number	Minimum minutes between emails
`max_leads_per_day`	number	Maximum new leads per day
`stop_lead_settings`	string	Activity that stops a lead sequence
`schedule_start_time`	string	Scheduled start time
`enable_ai_esp_matching`	boolean	Whether AI ESP matching is enabled
`send_as_plain_text`	boolean	Whether emails send as plain text
`follow_up_percentage`	number	Follow-up percentage
`unsubscribe_text`	string	Unsubscribe text
`parent_campaign_id`	number	Parent campaign ID
`client_id`	number	Client ID for agency accounts
`client_name`	string	Client name
`client_email`	string	Client email
`client_company_name`	string	Client company name
`tags`	array	Tags on the record
`email_campaign_id`	number	Campaign the webhook belongs to

Smartlead Delete Lead List

Deletes a Smartlead lead list.

Input

Parameter	Type	Required	Description
`leadListId`	number	Yes	Lead list ID to delete

Output

Parameter	Type	Description
`campaigns`	array	List of campaigns
`leads`	array	List of leads
`sequences`	array	Email sequence steps
`categories`	array	Lead categories
`webhooks`	array	Campaign webhooks
`stats`	array	Per-email statistics rows
`history`	array	Lead message history
`count`	number	Number of records returned
`total_leads`	number	Total leads in the campaign, or leads newly added when importing
`total_stats`	number	Total statistics rows matching the filters
`id`	number	Record ID
`name`	string	Record name
`status`	string	Campaign status
`email`	string	Lead email address
`webhook_url`	string	Webhook destination URL
`event_types`	array	Webhook event types
`sent_count`	number	Emails sent
`open_count`	number	Email opens
`click_count`	number	Link clicks
`reply_count`	number	Replies
`bounce_count`	number	Bounces
`campaign_lead_stats`	json	Lead counts by state
`upload_count`	number	Leads submitted in the request
`success`	boolean	Whether the action succeeded
`items`	array	Records returned by Smartlead
`rows`	array	Rows returned by Smartlead
`lists`	array	Lead lists
`summary`	array	Webhook delivery summary rows
`csv`	string	Exported leads as CSV
`row_count`	number	Rows in the exported CSV
`has_more`	boolean	Whether more rows are available
`list_name`	string	Lead list name
`positive_reply_count`	number	Replies categorized as positive
`offset`	number	Pagination offset used
`limit`	number	Pagination limit used
`total_count`	number	Total records matching the request
`from`	string	Start of the reported window
`to`	string	End of the reported window
`start_date`	string	Start of the reported range
`end_date`	string	End of the reported range
`skipped_count`	number	Emails skipped
`failed_count`	number	Failed sends
`stopped_count`	number	Stopped leads
`unsubscribed_count`	number	Unsubscribes
`unique_sent_count`	number	Unique leads emailed
`unique_open_count`	number	Unique opens
`unique_click_count`	number	Unique clicks
`block_count`	number	Blocked sends, or leads skipped by the block list
`drafted_count`	number	Drafted emails
`sequence_count`	number	Sequence steps in the campaign
`duplicate_count`	number	Duplicate leads skipped on import
`invalid_email_count`	number	Leads skipped for an invalid email
`invalid_emails`	array	Emails rejected as invalid
`already_added_to_campaign`	number	Leads already in the campaign
`unsubscribed_leads`	array	Leads skipped because they unsubscribed
`lead_import_stopped_count`	number	Leads whose import was stopped
`is_lead_limit_exhausted`	boolean	Whether the plan lead limit was hit
`is_last_sequence`	boolean	Whether the lead was on the final step
`next_sequence_id`	number	ID of the next sequence step
`next_sequence_delay_in_days`	number	Days before the next step
`first_name`	string	Lead first name
`last_name`	string	Lead last name
`phone_number`	string	Lead phone number
`company_name`	string	Lead company name
`website`	string	Lead website
`location`	string	Lead location
`linkedin_profile`	string	Lead LinkedIn profile URL
`company_url`	string	Lead company URL
`custom_fields`	json	Lead custom fields
`is_unsubscribed`	boolean	Whether the lead is unsubscribed
`lead_campaign_data`	array	Campaigns the lead belongs to
`created_at`	string	Creation timestamp
`updated_at`	string	Last update timestamp
`leads_count`	number	Leads in the list
`active_leads_count`	number	Active leads in the list
`track_settings`	array	Disabled tracking settings
`scheduler_cron_value`	json	Campaign sending schedule
`accounts`	array	Sending email accounts, excluding their stored mailbox credentials
`user_id`	number	Owning Smartlead user ID
`min_time_btwn_emails`	number	Minimum minutes between emails
`max_leads_per_day`	number	Maximum new leads per day
`stop_lead_settings`	string	Activity that stops a lead sequence
`schedule_start_time`	string	Scheduled start time
`enable_ai_esp_matching`	boolean	Whether AI ESP matching is enabled
`send_as_plain_text`	boolean	Whether emails send as plain text
`follow_up_percentage`	number	Follow-up percentage
`unsubscribe_text`	string	Unsubscribe text
`parent_campaign_id`	number	Parent campaign ID
`client_id`	number	Client ID for agency accounts
`client_name`	string	Client name
`client_email`	string	Client email
`client_company_name`	string	Client company name
`tags`	array	Tags on the record
`email_campaign_id`	number	Campaign the webhook belongs to

Smartlead List Clients

Retrieves the clients on a Smartlead agency account, including the client IDs used to scope campaigns and email accounts.

Input

Parameter	Type	Required	Description

Output

Parameter	Type	Description
`campaigns`	array	List of campaigns
`leads`	array	List of leads
`sequences`	array	Email sequence steps
`categories`	array	Lead categories
`webhooks`	array	Campaign webhooks
`stats`	array	Per-email statistics rows
`history`	array	Lead message history
`count`	number	Number of records returned
`total_leads`	number	Total leads in the campaign, or leads newly added when importing
`total_stats`	number	Total statistics rows matching the filters
`id`	number	Record ID
`name`	string	Record name
`status`	string	Campaign status
`email`	string	Lead email address
`webhook_url`	string	Webhook destination URL
`event_types`	array	Webhook event types
`sent_count`	number	Emails sent
`open_count`	number	Email opens
`click_count`	number	Link clicks
`reply_count`	number	Replies
`bounce_count`	number	Bounces
`campaign_lead_stats`	json	Lead counts by state
`upload_count`	number	Leads submitted in the request
`success`	boolean	Whether the action succeeded
`items`	array	Records returned by Smartlead
`rows`	array	Rows returned by Smartlead
`lists`	array	Lead lists
`summary`	array	Webhook delivery summary rows
`csv`	string	Exported leads as CSV
`row_count`	number	Rows in the exported CSV
`has_more`	boolean	Whether more rows are available
`list_name`	string	Lead list name
`positive_reply_count`	number	Replies categorized as positive
`offset`	number	Pagination offset used
`limit`	number	Pagination limit used
`total_count`	number	Total records matching the request
`from`	string	Start of the reported window
`to`	string	End of the reported window
`start_date`	string	Start of the reported range
`end_date`	string	End of the reported range
`skipped_count`	number	Emails skipped
`failed_count`	number	Failed sends
`stopped_count`	number	Stopped leads
`unsubscribed_count`	number	Unsubscribes
`unique_sent_count`	number	Unique leads emailed
`unique_open_count`	number	Unique opens
`unique_click_count`	number	Unique clicks
`block_count`	number	Blocked sends, or leads skipped by the block list
`drafted_count`	number	Drafted emails
`sequence_count`	number	Sequence steps in the campaign
`duplicate_count`	number	Duplicate leads skipped on import
`invalid_email_count`	number	Leads skipped for an invalid email
`invalid_emails`	array	Emails rejected as invalid
`already_added_to_campaign`	number	Leads already in the campaign
`unsubscribed_leads`	array	Leads skipped because they unsubscribed
`lead_import_stopped_count`	number	Leads whose import was stopped
`is_lead_limit_exhausted`	boolean	Whether the plan lead limit was hit
`is_last_sequence`	boolean	Whether the lead was on the final step
`next_sequence_id`	number	ID of the next sequence step
`next_sequence_delay_in_days`	number	Days before the next step
`first_name`	string	Lead first name
`last_name`	string	Lead last name
`phone_number`	string	Lead phone number
`company_name`	string	Lead company name
`website`	string	Lead website
`location`	string	Lead location
`linkedin_profile`	string	Lead LinkedIn profile URL
`company_url`	string	Lead company URL
`custom_fields`	json	Lead custom fields
`is_unsubscribed`	boolean	Whether the lead is unsubscribed
`lead_campaign_data`	array	Campaigns the lead belongs to
`created_at`	string	Creation timestamp
`updated_at`	string	Last update timestamp
`leads_count`	number	Leads in the list
`active_leads_count`	number	Active leads in the list
`track_settings`	array	Disabled tracking settings
`scheduler_cron_value`	json	Campaign sending schedule
`accounts`	array	Sending email accounts, excluding their stored mailbox credentials
`user_id`	number	Owning Smartlead user ID
`min_time_btwn_emails`	number	Minimum minutes between emails
`max_leads_per_day`	number	Maximum new leads per day
`stop_lead_settings`	string	Activity that stops a lead sequence
`schedule_start_time`	string	Scheduled start time
`enable_ai_esp_matching`	boolean	Whether AI ESP matching is enabled
`send_as_plain_text`	boolean	Whether emails send as plain text
`follow_up_percentage`	number	Follow-up percentage
`unsubscribe_text`	string	Unsubscribe text
`parent_campaign_id`	number	Parent campaign ID
`client_id`	number	Client ID for agency accounts
`client_name`	string	Client name
`client_email`	string	Client email
`client_company_name`	string	Client company name
`tags`	array	Tags on the record
`email_campaign_id`	number	Campaign the webhook belongs to

Smartlead

On this page