Smartlead
API integration

list_all_smartlead_campaigns

List all campaigns in Smartlead. Returns id, user_id, created_at, updated_at, status, name, track_settings, scheduler_cron_value, min_time_btwn_emails, max_leads_per_day, stop_lead_settings, unsubscribe_text, and client_id for each campaign.

create_a_smartlead_campaign

Create a campaign in Smartlead using required name parameter. Returns ok (operation status), id (campaign identifier), name (campaign name), and created_at (timestamp) in the response.

get_single_smartlead_campaign_by_id

Get details about a specific campaign in Smartlead using id. Returns fields such as id, user_id, status, name, scheduler_cron_value, min_time_btwn_emails, and other campaign settings in the response.

update_a_smartlead_campaign_by_id

Update general settings for a specific campaign in Smartlead using id. Returns ok field indicating success. Requires valid values for track_settings and stop_lead_settings.

delete_a_smartlead_campaign_by_id

Delete a campaign in Smartlead using id. Returns no content in the response.

smartlead_campaigns_top_level_analytics

Get top level analytics for a specific campaign in Smartlead. Requires id. Returns email stats fields such as sent_count, open_count, reply_count, sequence_count, tags, unique_open_count, client_name, campaign_lead_stats, and more in the response.

smartlead_campaigns_export_campaign_leads_csv

Export all leads from a campaign in Smartlead using id. Returns a CSV file with fields such as id, email, status, created_at, custom_fields, is_unsubscribed, is_interested, and engagement counts.

smartlead_campaigns_update_campaign_status

Update status of a campaign in Smartlead. Requires id. Returns success/failure indicating if campaign status was updated.

smartlead_campaigns_update_schedule

Update campaign schedule in Smartlead using id. Updates fields such as timezone, days_of_the_week, start_hour, end_hour, min_time_btw_emails, max_new_leads_per_day, and schedule_start_time. These fields are returned in the response.

list_all_smartlead_email_accounts

List all email accounts in Smartlead used for sending emails to leads. Returns email account details including fields like provider, email, name, and sending status.

create_a_smartlead_email_account

Create a specific email account in Smartlead using id. Returns key fields such as id, from_name, from_email, user_name, smtp_host, smtp_port, imap_host, and imap_port in the response. Requires id in the request body.

get_single_smartlead_email_account_by_id

Get email account details in Smartlead by id. Returns all email details including account_id, account status, and connection settings for the specified id.

update_a_smartlead_email_account_by_id

Update email-accounts in Smartlead. Requires id. Returns updated fields such as max_email_per_day, custom_tracking_url, bcc, signature, client_id, and time_to_wait_in_mins.

smartlead_email_accounts_reconnect_failed_emails

Reconnect failed email-accounts in Smartlead. Returns results for each attempted reconnection, including account identifiers and statuses.

list_all_smartlead_campaign_email_accounts

List all email accounts for a campaign in Smartlead. Requires campaign_id. Returns id, user_id, from_email, smtp details, imap details, type, and daily_sent_count for each account.

create_a_smartlead_campaign_email_account

Add an email account to a campaign in Smartlead. Requires campaign_id. Returns id, email_campaign_id, email_account_id, and updated_at for the linked account.

delete_a_smartlead_campaign_email_account_by_id

Delete an email account from a campaign in Smartlead. Requires campaign_id and id. Returns confirmation of successful removal.

list_all_smartlead_campaign_leads

List all leads for a specific campaign in Smartlead. Requires campaign_id. Returns campaign_lead_map_id, status, created_at, and lead fields such as id, first_name, last_name, email, company_name, and is_unsubscribed.

create_a_smartlead_campaign_lead

Add leads to a campaign in Smartlead using campaign_id. Requires campaign_id. Returns fields for each added lead including first_name, last_name, email, phone_number, company_name, website, location, custom_fields, linkedin_profile, and company_url.

delete_a_smartlead_campaign_lead_by_id

Delete a lead from a campaign in Smartlead. Requires campaign_id and id. Returns ok field in the response to indicate if the operation was successful.

smartlead_campaign_leads_unsubscribe_lead

Unsubscribe a specific campaign-lead from a campaign in Smartlead. Requires campaign_id and id. Returns ok indicating the success status.

smartlead_campaign_leads_pause_lead

Pause a specific campaign-lead in Smartlead. Requires campaign_id and id. Returns confirmation of the lead being paused.

smartlead_campaign_leads_resume_leads

Resume campaign-leads in Smartlead using campaign_id and id. Returns status and updated lead information in the response.

smartlead_campaign_leads_reply_to_lead

Reply to a lead in Smartlead via the Master Inbox API. Requires campaign_id. Returns information on the sent reply, including email_stats_id and reply_message_id.

update_a_smartlead_campaign_lead_by_id

Update a lead in Smartlead using campaign_id and id. Returns updated lead fields, including lead status, contact details, and any changes applied.

smartlead_campaign_leads_update_lead_category

Update a campaign-leads category in Smartlead. Requires campaign_id and id as parameters. Returns the updated category_id and the status of pause_lead in the response.

list_all_smartlead_leads

Get lead details in Smartlead using email. Requires email. Returns id, first_name, last_name, email, created_at, phone_number, company_name, website, location, custom_fields, linkedin_profile, company_url, is_unsubscribed.

smartlead_leads_unsubscribe

Unsubscribe a lead from all campaigns in Smartlead using id. Removes the lead from existing campaigns and blocks from future campaigns. Returns status indicating successful unsubscription.

smartlead_leads_block

Add leads or domains to the global block list in Smartlead. Returns a success/failure response indicating if the operation completed successfully.

list_all_smartlead_lead_campaigns

List all lead-campaigns for a specific lead in Smartlead using id. Returns campaign id, status, and name fields in the response.

list_all_smartlead_campaign_sequences

Get campaign sequence data in Smartlead for a specific campaign_id. Returns id, created_at, updated_at, email_campaign_id, seq_number, subject, email_body, and sequence_variants with their respective fields in the response.

list_all_smartlead_campaign_statistics_by_date

Fetch campaign statistics by campaign_id, start_date, and end_date in Smartlead. Returns fields such as id, user_id, created_at, status, name, sent_count, open_count, click_count, reply_count, block_count, total_count, drafted_count, bounce_count, and unsubscribed_count.

list_all_smartlead_lead_category

List lead categories in Smartlead. Returns id, created_at, and name fields for each lead-category.

list_all_smartlead_campaign_lead_message_history

Get the entire message history for a specific lead in a campaign in Smartlead. Requires campaign_id and id. Returns an array of messages with type, message_id, stats_id, time, email_body, and subject fields.

list_all_smartlead_campaign_statistics

Fetch campaign statistics in Smartlead for a specific campaign using id. Returns fields including lead_name, lead_email, sequence_number, email_subject, sent_time, open_count, click_count, is_unsubscribed, and is_bounced.

list_all_smartlead_campaign_webhooks

List all campaign-webhooks in Smartlead for a specific campaign using campaign_id. Returns id, name, created_at, updated_at, webhook_url, email_campaign_id, event_types, and categories for each webhook.

update_a_smartlead_campaign_webhook_by_id

update a campaign-webhooks resource in Smartlead for a given campaign_id. Requires campaign_id in the path and returns the webhook's id, name, webhook_url, event_types, and categories in the response.

create_a_smartlead_campaign_webhook

Add a campaign webhook in Smartlead. Requires campaign_id. Returns webhook fields including id, name, webhook_url, event_types, and categories.

delete_a_smartlead_campaign_webhook_by_id

Delete a campaign webhook in Smartlead. Requires campaign_id and id. No content is returned in the response upon successful deletion.

get_single_smartlead_email_account_warmup_stat_by_id

Fetch warmup stats for the last 7 days by email account in Smartlead. Requires id. Returns id, sent_count, spam_count, inbox_count, warmup_email_received_count, and stats_by_date with daily stats.

create_a_smartlead_email_account_warmup_setting

Add or update warmup settings for an email account in Smartlead. Requires id. Returns updated warmup_enabled, total_warmup_per_day, daily_rampup, reply_rate_percentage, and warmup_key_id fields in the response.

create_a_smartlead_client

Create a new client in Smartlead. Requires name, email, permission, logo, and password. Returns the created client's id, name, email, permissions, and logo in the response.

list_all_smartlead_clients

Fetch all clients in Smartlead. Returns id, name, email, uuid, created_at, user_id, logo, logo_url, and client_permission fields for each client.