Smartlead

Smartlead

This connector uses the Smartlead REST API (https://server.smartlead.ai/api/v1) for cold email outreach: campaigns and their sequences, schedules and mailboxes, leads, replies in the master inbox, analytics, sender mailboxes with warmup, and webhooks.

Setup

1. In Smartlead open Settings and the API Keys section (on some plans under Settings, Integrations). API access needs a paid plan.
2. Copy the API key into SMARTLEAD_API_KEY.

The key travels as the api_key query parameter on every request; the connector adds it. It gives full access to the account, so treat it like a password.

Campaigns

• smartlead_list_campaigns first: the id of each campaign is the campaign_id of every other tool. smartlead_get_campaign, smartlead_get_campaign_sequences and smartlead_list_campaign_email_accounts show its setup.
• Build a campaign: smartlead_create_campaign, smartlead_save_campaign_sequences, smartlead_update_campaign_schedule, smartlead_update_campaign_settings, smartlead_add_email_accounts_to_campaign, smartlead_add_leads_to_campaign, then smartlead_update_campaign_status with START.
• smartlead_update_campaign_status: START (not ACTIVE), PAUSED, STOPPED (final) or ARCHIVED.
• smartlead_save_campaign_sequences replaces the whole sequence: read it with smartlead_get_campaign_sequences first, keep the step ids and send every step. Personalise with {{first_name}}, {{company_name}} and custom field names.

Leads

• smartlead_list_campaign_leads lists a campaign's leads; each row has the campaign lead map id (id of the row, used by smartlead_create_lead_note) and the lead itself (lead.id, used as lead_id).
• smartlead_get_lead_by_email finds a lead anywhere; smartlead_get_lead reads one by id; smartlead_get_lead_campaign_overview shows all its campaigns.
• Change a lead: smartlead_update_lead, smartlead_update_lead_category (ids from smartlead_list_lead_categories), smartlead_pause_lead, smartlead_resume_lead.
• Stop a lead: smartlead_unsubscribe_lead_from_campaign (one campaign), smartlead_unsubscribe_lead_globally (all campaigns, also blocks future imports), smartlead_delete_lead_from_campaign.
• smartlead_add_leads_to_campaign takes at most 400 leads per call.

Replies

• smartlead_list_inbox_replies lists replies across campaigns (filters by campaign, mailbox, category, reply time); smartlead_get_inbox_item opens one thread.
• To answer: smartlead_get_lead_message_history gives each message's stats_id, message_id and time; pass them as email_stats_id, reply_message_id and reply_email_time to smartlead_reply_to_lead. The reply leaves from the mailbox of that thread.
• smartlead_create_lead_note adds an internal note.

Analytics

• Per campaign: smartlead_get_campaign_analytics (all-time totals), smartlead_get_campaign_analytics_by_date, smartlead_get_campaign_sequence_analytics (per step and variant), smartlead_get_campaign_statistics (one row per sent email).
• Whole account: smartlead_get_overall_analytics.
• Counts are numbers of emails or leads; rates are percentages. Dates are YYYY-MM-DD; timestamps are ISO 8601 in UTC unless a time zone is passed.

Mailboxes: smartlead_list_email_accounts (find broken connections with isSmtpSuccess=false), smartlead_get_email_account, smartlead_get_warmup_stats, smartlead_update_email_account, smartlead_update_warmup.

Webhooks: smartlead_list_campaign_webhooks, smartlead_upsert_campaign_webhook (create, or update when id is given), smartlead_delete_campaign_webhook. Event types: EMAIL_SENT, EMAIL_OPEN, EMAIL_LINK_CLICK, EMAIL_REPLY, EMAIL_BOUNCE, LEAD_UNSUBSCRIBED, LEAD_CATEGORY_UPDATED.

Agencies and lists: smartlead_list_clients gives the client ids that filter campaigns and mailboxes; smartlead_list_lead_lists lists lead lists.

Paging: lists take offset (default 0) and limit (default 100; the inbox defaults to 20). Increase offset by limit until fewer rows than limit come back.

Limits and errors: Smartlead throttles bursts (about 10 requests per 2 seconds on standard plans) and answers 429; wait and retry. 401 Invalid API Key means a wrong key; 404 a wrong id or an id from another account; 400 names the invalid field.

Switched off at install: smartlead_unsubscribe_lead_globally, smartlead_delete_lead_from_campaign and smartlead_delete_campaign_webhook; they cannot be undone, so an admin switches them on when the team needs them.