---
canonical_url: "https://docs.composio.dev/toolkits/smartlead"
markdown_url: "https://docs.composio.dev/toolkits/smartlead.md"
product: "platform"
version: null
last_updated: null
---

# Smartlead

Smartlead is a sales engagement platform for managing cold email campaigns, leads, sending accounts, inbox activity, deliverability, prospecting, and sender provisioning.

- **Category:** ai sales tools
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 33
- **Triggers:** 0
- **Slug:** `SMARTLEAD`
- **Version:** 20261007_00

## Tools

### Create Draft Campaign

**Slug:** `SMARTLEAD_CREATE_CAMPAIGN`

Create a new campaign in DRAFTED status. This creates persistent account data but does not send email or start the campaign.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Distinct name for the draft campaign. |
| `client_id` | integer | No | Client sub-account ID that should own the campaign, if applicable. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Smart Delivery Folder

**Slug:** `SMARTLEAD_CREATE_DELIVERY_FOLDER`

Create an organizational folder for Smart Delivery tests. This creates persistent data but does not run or send a test.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `folder_name` | string | Yes | Distinct name for the new Smart Delivery test folder. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Campaign

**Slug:** `SMARTLEAD_DELETE_CAMPAIGN`

Permanently delete a campaign and all associated sequences, mappings, and statistics. This is irreversible and requires explicit confirmation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `campaign_id` | integer | Yes | Campaign ID to permanently delete. |
| `confirm_irreversible` | boolean | Yes | Must be true to acknowledge that deleting the campaign and its associated data is permanent. This confirmation is not sent to Smartlead. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Campaign Lead

**Slug:** `SMARTLEAD_DELETE_CAMPAIGN_LEAD`

Remove one lead from a selected campaign without deleting the campaign.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lead_id` | integer | Yes | Lead to remove from the campaign. |
| `campaign_id` | integer | Yes | Campaign containing the lead to remove. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Smart Delivery Folder

**Slug:** `SMARTLEAD_DELETE_DELIVERY_FOLDER`

Delete an empty Smart Delivery folder. The folder must contain no tests, and deletion requires explicit confirmation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `folder_id` | string | Yes | ID of the empty Smart Delivery folder to delete. |
| `confirm_delete` | boolean | Yes | Must be true to acknowledge deletion of the empty folder. This confirmation is validated locally and is not sent to Smartlead. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Campaign

**Slug:** `SMARTLEAD_GET_CAMPAIGN`

Get configuration and performance summary for one Smartlead campaign by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `campaign_id` | integer | Yes | Campaign ID returned by a list or create campaign operation. |
| `include_tags` | boolean | No | Whether to include campaign tags in the response. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Campaign Analytics

**Slug:** `SMARTLEAD_GET_CAMPAIGN_ANALYTICS`

Retrieve lifetime campaign performance analytics, or date-bounded analytics when start and end dates are supplied together.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end_date` | string | No | Last analytics date in YYYY-MM-DD format; requires start_date and must be no more than 30 days after it. |
| `time_zone` | string | No | IANA time zone used for date boundaries on date-bounded analytics. |
| `start_date` | string | No | First analytics date in YYYY-MM-DD format; requires end_date. |
| `campaign_id` | integer | Yes | Campaign whose performance analytics to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Campaigns

**Slug:** `SMARTLEAD_GET_CAMPAIGNS`

Get configuration and performance summaries for 1-20 Smartlead campaigns. Returns one success or failure result per campaign ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `campaign_ids` | array | Yes | Campaign IDs to retrieve in order (1-20 IDs). |
| `include_tags` | boolean | No | Whether to include campaign tags in each campaign response. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Campaign Sequences

**Slug:** `SMARTLEAD_GET_CAMPAIGN_SEQUENCES`

Get a campaign's ordered email sequence steps, including message content, delays, and A/B test variants.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `campaign_id` | integer | Yes | Campaign whose ordered email sequence steps to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Campaign Statistics

**Slug:** `SMARTLEAD_GET_CAMPAIGN_STATISTICS`

Return one offset-paginated page of email-level campaign statistics, optionally filtered by sequence step, engagement status, or sent time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum statistics records to return (1-1000). |
| `offset` | integer | No | Zero-based result offset. |
| `campaign_id` | integer | Yes | Campaign whose email-level statistics to retrieve. |
| `email_status` | string ("opened" | "clicked" | "replied" | "unsubscribed" | "bounced") | No | Return only emails that were opened, clicked, replied to, unsubscribed, or bounced. |
| `sent_time_end_date` | string | No | Inclusive sent-time end in ISO 8601 format. |
| `sent_time_start_date` | string | No | Inclusive sent-time start in ISO 8601 format. |
| `email_sequence_number` | integer | No | Return statistics only for this campaign sequence step (1-20). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Smart Delivery Test

**Slug:** `SMARTLEAD_GET_DELIVERY_TEST`

Get the documented configuration for one Smart Delivery spam test by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `spam_test_id` | string | Yes | Spam test ID returned by List Smart Delivery Tests. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Email Account Warmup Statistics

**Slug:** `SMARTLEAD_GET_EMAIL_ACCOUNT_WARMUP_STATS`

Retrieve recent daily warmup performance statistics for one Smartlead sending account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email_account_id` | integer | Yes | Sending account ID returned by LIST_EMAIL_ACCOUNTS. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Inbox Conversation

**Slug:** `SMARTLEAD_GET_INBOX_CONVERSATION`

Retrieve one Master Inbox conversation by campaign-lead-map ID, including its complete message history when the thread contains messages.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `inbox_item_id` | integer | Yes | Campaign-lead-map ID from inbox or campaign lead results. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Lead by Email

**Slug:** `SMARTLEAD_GET_LEAD_BY_EMAIL`

Find an account-wide Smartlead lead by exact email address and return its contact details and campaign memberships.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | Yes | Exact lead email address to find across the Smartlead account. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Lead Message History

**Slug:** `SMARTLEAD_GET_LEAD_MESSAGE_HISTORY`

Get a campaign lead's email conversation history, optionally filtering by time and including plain text bodies.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lead_id` | integer | Yes | Lead whose conversation history to retrieve. |
| `campaign_id` | integer | Yes | Campaign containing the lead. |
| `event_time_gt` | string | No | Return messages after this ISO 8601 timestamp. |
| `show_plain_text_response` | boolean | No | Include plain text email content when available. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Smart Prospect Usage

**Slug:** `SMARTLEAD_GET_PROSPECT_USAGE`

Get Smart Prospect lead-search metrics, fetch counts, daily limits, and available credit balance. This read does not consume credits.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `filter_id` | string | No | Optional numeric Smart Prospect filter ID for filter-specific lead and email metrics. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Campaign Leads

**Slug:** `SMARTLEAD_LIST_CAMPAIGN_LEADS`

Return one offset-paginated page of leads in a campaign with optional status, category, engagement, and date filters.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum leads to return (1-100). |
| `offset` | integer | No | Zero-based result offset. |
| `status` | string ("STARTED" | "INPROGRESS" | "COMPLETED" | "PAUSED" | "STOPPED") | No | Return leads with this sequence status. |
| `campaign_id` | integer | Yes | Campaign whose leads to list. |
| `email_status` | string ("is_opened" | "is_clicked" | "is_bounced" | "is_replied" | "is_unsubscribed" | "is_spam" | "is_accepted" | "not_replied" | "is_sender_bounced") | No | Return leads matching this email engagement status. |
| `created_at_gt` | string | No | Return leads created after this ISO 8601 date-time. |
| `event_time_gt` | string | No | Return leads whose last event is after this ISO 8601 date-time. |
| `lead_category_id` | integer | No | Return leads assigned to this category ID. |
| `last_sent_time_gt` | string | No | Return leads last emailed after this ISO 8601 date-time. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Campaigns

**Slug:** `SMARTLEAD_LIST_CAMPAIGNS`

List campaigns visible to the connected Smartlead account, optionally for one client.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `client_id` | integer | No | Return only campaigns belonging to this client ID. |
| `include_tags` | boolean | No | Include campaign tags in each result. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Smart Delivery Folders

**Slug:** `SMARTLEAD_LIST_DELIVERY_FOLDERS`

List folders used to organize Smart Delivery tests.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Smart Delivery Tests

**Slug:** `SMARTLEAD_LIST_DELIVERY_TESTS`

List Smart Delivery spam and inbox-placement tests. This POST endpoint is read-only and does not create or send a test.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Email Accounts

**Slug:** `SMARTLEAD_LIST_EMAIL_ACCOUNTS`

List connected sending accounts with health, warmup, usage, provider, and campaign filters. Credential-like response fields are always removed.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum accounts to return in this page (1-100). |
| `in_use` | boolean | No | Filter by whether the account is used in campaigns. |
| `provider` | string ("GMAIL" | "OUTLOOK" | "SMTP") | No | Filter by email service provider. |
| `username` | string | No | Partially match the sending username. |
| `client_id` | integer | No | Filter accounts by client ID. |
| `next_cursor` | string | No | Opaque continuation cursor returned by a previous call. |
| `warmup_status` | string ("ACTIVE" | "INACTIVE") | No | Filter by ACTIVE or INACTIVE warmup status. |
| `smtp_connected` | boolean | No | Filter by SMTP connection success. |
| `warmup_blocked` | boolean | No | Filter by whether warmup is blocked. |
| `include_campaign_ids` | boolean | No | Include campaign IDs attached to each account. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Inbox Replies

**Slug:** `SMARTLEAD_LIST_INBOX_REPLIES`

List lead replies across campaigns from Master Inbox using bounded filters and one page at a time. This reads email content but does not send or modify messages.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum replies in this page (1-20). |
| `search` | string | No | Match lead email, name, or message text (maximum 30 characters). |
| `sort_by` | string ("REPLY_TIME_DESC" | "SENT_TIME_DESC") | No | Sort by most recent reply time or most recent sent time. |
| `next_cursor` | string | No | Opaque continuation cursor returned by a previous call. Omit for the first page. |
| `campaign_ids` | array | No | Campaign IDs to include (maximum five). |
| `category_ids` | array | No | Lead category IDs to include (maximum 10). |
| `email_statuses` | array | No | Engagement statuses to include. |
| `email_account_ids` | array | No | Sending-account IDs to include (maximum 20). |
| `reply_time_between` | array | No | Exactly two ISO 8601 timestamps defining the reply-time range. |
| `include_message_history` | boolean | No | Include complete conversation threads. False returns only the latest message and is faster. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Smart Prospect Industries

**Slug:** `SMARTLEAD_LIST_PROSPECT_INDUSTRIES`

List and search Smart Prospect industry filter values without searching contacts or consuming contact-fetch credits.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum industries to return in this page (1-100). |
| `search` | string | No | Prefix to match against industry names. |
| `next_cursor` | string | No | Opaque continuation cursor returned by a previous call. |
| `include_sub_industries` | boolean | No | Include sub-industry values for each industry. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Purchased Smart Senders Domains

**Slug:** `SMARTLEAD_LIST_PURCHASED_DOMAINS`

List domains already purchased through Smart Senders. This is read-only and does not purchase domains or provision mailboxes.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Saved Smart Prospect Searches

**Slug:** `SMARTLEAD_LIST_SAVED_PROSPECT_SEARCHES`

List saved Smart Prospect search definitions without executing them or consuming contact-search credits.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum saved searches to return in this page. |
| `next_cursor` | string | No | Continuation cursor returned by a previous call. Omit for the first page and pass it back unchanged to continue. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Smart Senders Vendors

**Slug:** `SMARTLEAD_LIST_SENDER_VENDORS`

List Smart Senders marketplace vendors and current domain/mailbox pricing without placing an order.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Resume Campaign Lead

**Slug:** `SMARTLEAD_RESUME_CAMPAIGN_LEAD`

Resume a paused lead in a campaign, optionally after a delay.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lead_id` | integer | Yes | Paused lead to resume. |
| `campaign_id` | integer | Yes | Campaign containing the paused lead. |
| `resume_lead_with_delay_days` | integer | No | Days to wait before resuming; omit to use the sequence default. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Available Smart Senders Domains

**Slug:** `SMARTLEAD_SEARCH_AVAILABLE_DOMAINS`

Check Smart Senders marketplace domain availability for a vendor. This read-only search does not purchase a domain, place an order, or provision mailboxes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `vendor_id` | integer | Yes | Vendor ID returned by List Smart Senders Vendors. |
| `domain_name` | string | Yes | Domain name or candidate text to check for marketplace availability. This search does not purchase the domain. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Smart Prospect Contacts (Consumes Credits)

**Slug:** `SMARTLEAD_SEARCH_PROSPECT_CONTACTS`

Search one page of Smart Prospect contacts. The initial call and every explicit continuation may consume credits; inspect usage first, choose the smallest useful limit, and confirm each page.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | Yes | Contacts to return in this credit-consuming page (1-500). Choose the smallest useful value. |
| `filters` | object | Yes | Person and company filters for the contact search. Provide at least one non-empty list filter, such as titles or countries, or set exclude_owned_contacts to true. Example: {"titles":["VP Sales"],"countries":["United States"]}. |
| `next_cursor` | string | No | Opaque cursor returned by a previous page. Continuing performs another credit-consuming call. |
| `confirm_credit_consumption` | boolean | Yes | Must be true to acknowledge that this page may consume Smart Prospect credits. This confirmation is validated locally and is not sent upstream. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Send Single Email

**Slug:** `SMARTLEAD_SEND_SINGLE_EMAIL`

Immediately send one email outside a campaign from a connected Smartlead sender account. This externally visible action cannot be undone.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `to` | string | Yes | Recipient email address. |
| `body` | string | Yes | HTML or plain-text email body. |
| `subject` | string | Yes | Email subject. |
| `reply_to` | string | No | Reply-to email address. |
| `from_name` | string | No | Sender display name. |
| `from_email` | string | No | Sender email address; provide exactly one of this or from_email_id. |
| `attachments` | array | No | Files to attach, each with a filename, base64-encoded content, and provider-required mimeType. |
| `from_email_id` | integer | No | Smartlead sender account ID; provide exactly one of this or from_email. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Unsubscribe Campaign Lead

**Slug:** `SMARTLEAD_UNSUBSCRIBE_CAMPAIGN_LEAD`

Permanently unsubscribe a campaign lead from future email. This cannot be undone through the Smartlead API.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lead_id` | integer | Yes | Lead to unsubscribe permanently; this cannot be undone through the API. |
| `campaign_id` | integer | Yes | Campaign containing the lead to unsubscribe permanently. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Campaign Lead

**Slug:** `SMARTLEAD_UPDATE_CAMPAIGN_LEAD`

Update one campaign lead's contact information and merge custom fields using Smartlead's current campaign-lead endpoint.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | Yes | Current or replacement email address required by Smartlead. |
| `lead_id` | integer | Yes | Lead to update. |
| `website` | string | No | Updated website URL. |
| `location` | string | No | Updated location. |
| `last_name` | string | No | Updated last name. |
| `first_name` | string | No | Updated first name. |
| `campaign_id` | integer | Yes | Campaign containing the lead. |
| `company_url` | string | No | Updated company URL. |
| `company_name` | string | No | Updated company name. |
| `phone_number` | string | No | Updated phone number. |
| `custom_fields` | object | No | Up to 200 custom fields to merge into the lead. |
| `linkedin_profile` | string | No | Updated LinkedIn profile URL. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Campaign Status

**Slug:** `SMARTLEAD_UPDATE_CAMPAIGN_STATUS`

Start, pause, stop, or archive a campaign. STOPPED is permanent and cannot be undone; START can begin sending emails.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `status` | string ("START" | "PAUSED" | "STOPPED" | "ARCHIVED") | Yes | New campaign status. STOPPED permanently stops the campaign and cannot be undone; START can begin sending emails. |
| `campaign_id` | integer | Yes | Campaign to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |