# Smartlead

> Manage Smartlead campaigns, sending schedules, sequences, leads and email accounts; read campaign analytics.

App · 25 actions. Web page: https://docs.lodol.com/docs/integrations/smartlead

## Actions

### Add campaign email accounts

Add campaign email accounts.

**Inputs**

- Campaign (`campaign_id`, number, required): Campaign id. At least 1.
- Email account IDS (`email_account_ids`, list, required): Email account ids.

**Outputs**

- `data` (object): Complete Smartlead response, including offset and total counts where returned.
- `has_more` (true/false): Whether the service reports another page.
- `next_cursor` (text): Cursor for the next page, when supplied by the service.

**Example output**

```json
{
  "data": null,
  "has_more": false,
  "next_cursor": ""
}
```

### Add campaign leads

Add campaign leads.

**Inputs**

- Campaign (`campaign_id`, number, required): Campaign id. At least 1.
- Lead list (`lead_list`, list, required): Lead list.
- Settings (`settings`, object): Settings.

**Outputs**

- `data` (object): Complete Smartlead response, including offset and total counts where returned.
- `has_more` (true/false): Whether the service reports another page.
- `next_cursor` (text): Cursor for the next page, when supplied by the service.

**Example output**

```json
{
  "data": null,
  "has_more": false,
  "next_cursor": ""
}
```

### Create campaign

Create campaign.

**Inputs**

- Name (`name`, text): Name.
- Client ID (`client_id`, number): Client id.

**Outputs**

- `data` (object): Complete Smartlead response, including offset and total counts where returned.
- `has_more` (true/false): Whether the service reports another page.
- `next_cursor` (text): Cursor for the next page, when supplied by the service.

**Example output**

```json
{
  "data": null,
  "has_more": false,
  "next_cursor": ""
}
```

### Delete campaign

Delete campaign.

**Inputs**

- Campaign (`campaign_id`, number, required): Campaign id. At least 1.

**Outputs**

- `data` (object): Complete Smartlead response, including offset and total counts where returned.
- `has_more` (true/false): Whether the service reports another page.
- `next_cursor` (text): Cursor for the next page, when supplied by the service.

**Example output**

```json
{
  "data": null,
  "has_more": false,
  "next_cursor": ""
}
```

### Get campaign

Get campaign.

**Inputs**

- Campaign (`campaign_id`, number, required): Campaign id. At least 1.
- Include tags (`include_tags`, text): Include tags. One of: `true`, `false`.

**Outputs**

- `data` (object): Complete Smartlead response, including offset and total counts where returned.
- `has_more` (true/false): Whether the service reports another page.
- `next_cursor` (text): Cursor for the next page, when supplied by the service.

**Example output**

```json
{
  "data": null,
  "has_more": false,
  "next_cursor": ""
}
```

### Get campaign analytics

Get campaign analytics.

**Inputs**

- Campaign (`campaign_id`, number, required): Campaign id. At least 1.

**Outputs**

- `data` (object): Complete Smartlead response, including offset and total counts where returned.
- `has_more` (true/false): Whether the service reports another page.
- `next_cursor` (text): Cursor for the next page, when supplied by the service.

**Example output**

```json
{
  "data": null,
  "has_more": false,
  "next_cursor": ""
}
```

### Get campaign email accounts

Get campaign email accounts.

**Inputs**

- Campaign (`campaign_id`, number, required): Campaign id. At least 1.
- Include tags (`include_tags`, text): Include tags. One of: `true`, `false`.

**Outputs**

- `data` (list): Every record on this page.
- `has_more` (true/false): Whether the service reports another page.
- `next_cursor` (text): Cursor for the next page, when supplied by the service.

**Example output**

```json
{
  "data": [],
  "has_more": false,
  "next_cursor": ""
}
```

### Get campaign statistics

Get campaign statistics.

**Inputs**

- Campaign (`campaign_id`, number, required): Campaign id. At least 1.
- Offset (`offset`, number): Offset. At least 0.
- Limit (`limit`, number): Limit. From 1 to 100.
- Email sequence number (`email_sequence_number`, number): Email sequence number.
- Email status (`email_status`, text): Email status.
- Sent time start date (`sent_time_start_date`, date): Sent time start date.
- Sent time end date (`sent_time_end_date`, date): Sent time end date.

**Outputs**

- `data` (object): Complete Smartlead response, including offset and total counts where returned.
- `has_more` (true/false): Whether the service reports another page.
- `next_cursor` (text): Cursor for the next page, when supplied by the service.

**Example output**

```json
{
  "data": null,
  "has_more": false,
  "next_cursor": ""
}
```

### Get email account

Get email account.

**Inputs**

- Email account ID (`email_account_id`, number, required): Email account id. At least 1.
- Fetch campaigns (`fetch_campaigns`, text): Fetch campaigns. One of: `true`, `false`.

**Outputs**

- `data` (object): Complete Smartlead response, including offset and total counts where returned.
- `has_more` (true/false): Whether the service reports another page.
- `next_cursor` (text): Cursor for the next page, when supplied by the service.

**Example output**

```json
{
  "data": null,
  "has_more": false,
  "next_cursor": ""
}
```

### Get lead

Get lead.

**Inputs**

- Lead ID (`lead_id`, number, required): Lead id. At least 1.

**Outputs**

- `data` (object): Complete Smartlead response, including offset and total counts where returned.
- `has_more` (true/false): Whether the service reports another page.
- `next_cursor` (text): Cursor for the next page, when supplied by the service.

**Example output**

```json
{
  "data": null,
  "has_more": false,
  "next_cursor": ""
}
```

### Get lead history

Get lead history.

**Inputs**

- Campaign (`campaign_id`, number, required): Campaign id. At least 1.
- Lead ID (`lead_id`, number, required): Lead id. At least 1.
- Event time gt (`event_time_gt`, date and time): Event time gt.
- Show plain text response (`show_plain_text_response`, true/false): Show plain text response.

**Outputs**

- `data` (object): Complete Smartlead response, including offset and total counts where returned.
- `has_more` (true/false): Whether the service reports another page.
- `next_cursor` (text): Cursor for the next page, when supplied by the service.

**Example output**

```json
{
  "data": null,
  "has_more": false,
  "next_cursor": ""
}
```

### Get sequences

Get sequences.

**Inputs**

- Campaign (`campaign_id`, number, required): Campaign id. At least 1.

**Outputs**

- `data` (list): Every record on this page.
- `has_more` (true/false): Whether the service reports another page.
- `next_cursor` (text): Cursor for the next page, when supplied by the service.

**Example output**

```json
{
  "data": [],
  "has_more": false,
  "next_cursor": ""
}
```

### List campaign leads

List campaign leads.

**Inputs**

- Campaign (`campaign_id`, number, required): Campaign id. At least 1.
- Offset (`offset`, number): Offset. At least 0.
- Limit (`limit`, number): Limit. From 1 to 100.
- Created at gt (`created_at_gt`, date and time): Created at gt.
- Last sent time gt (`last_sent_time_gt`, date and time): Last sent time gt.
- Event time gt (`event_time_gt`, date and time): Event time gt.
- Status (`status`, text): Status. One of: `STARTED`, `INPROGRESS`, `COMPLETED`, `PAUSED`, `STOPPED`.
- Lead category ID (`lead_category_id`, number): Lead category id.
- EmailStatus (`emailStatus`, text): Emailstatus. One of: `is_opened`, `is_clicked`, `is_bounced`, `is_replied`, `is_unsubscribed`, `is_spam`, `is_accepted`.

**Outputs**

- `data` (object): Complete Smartlead response, including offset and total counts where returned.
- `has_more` (true/false): Whether the service reports another page.
- `next_cursor` (text): Cursor for the next page, when supplied by the service.

**Example output**

```json
{
  "data": null,
  "has_more": false,
  "next_cursor": ""
}
```

### List campaigns

List campaigns.

**Inputs**

- Client ID (`client_id`, number): Client id.
- Include tags (`include_tags`, text): Include tags. One of: `true`, `false`.

**Outputs**

- `data` (list): Every record on this page.
- `has_more` (true/false): Whether the service reports another page.
- `next_cursor` (text): Cursor for the next page, when supplied by the service.

**Example output**

```json
{
  "data": [],
  "has_more": false,
  "next_cursor": ""
}
```

### List email accounts

List email accounts.

**Inputs**

- Offset (`offset`, number): Offset. At least 0.
- Limit (`limit`, number): Limit. From 1 to 100.
- IsInUse (`isInUse`, text): Isinuse. One of: `true`, `false`.
- EmailWarmupStatus (`emailWarmupStatus`, text): Emailwarmupstatus. One of: `ACTIVE`, `INACTIVE`.
- IsSmtpSuccess (`isSmtpSuccess`, text): Issmtpsuccess. One of: `true`, `false`.
- IsWarmupBlocked (`isWarmupBlocked`, text): Iswarmupblocked. One of: `true`, `false`.
- Esp (`esp`, text): Esp. One of: `GMAIL`, `OUTLOOK`, `SMTP`.
- Username (`username`, text): Username.
- Client ID (`client_id`, number): Client id.
- Fetch campaigns (`fetch_campaigns`, text): Fetch campaigns. One of: `true`, `false`.

**Outputs**

- `data` (list): Every record on this page.
- `has_more` (true/false): Whether the service reports another page.
- `next_cursor` (text): Cursor for the next page, when supplied by the service.

**Example output**

```json
{
  "data": [],
  "has_more": false,
  "next_cursor": ""
}
```

### List lead categories

List lead categories.

**Inputs**: None.

**Outputs**

- `data` (list): Every record on this page.
- `has_more` (true/false): Whether the service reports another page.
- `next_cursor` (text): Cursor for the next page, when supplied by the service.

**Example output**

```json
{
  "data": [],
  "has_more": false,
  "next_cursor": ""
}
```

### Pause campaign lead

Pause campaign lead.

**Inputs**

- Campaign (`campaign_id`, number, required): Campaign id. At least 1.
- Lead ID (`lead_id`, number, required): Lead id. At least 1.

**Outputs**

- `data` (object): Complete Smartlead response, including offset and total counts where returned.
- `has_more` (true/false): Whether the service reports another page.
- `next_cursor` (text): Cursor for the next page, when supplied by the service.

**Example output**

```json
{
  "data": null,
  "has_more": false,
  "next_cursor": ""
}
```

### Remove campaign email accounts

Remove campaign email accounts.

**Inputs**

- Campaign (`campaign_id`, number, required): Campaign id. At least 1.
- Email account IDS (`email_account_ids`, list, required): Email account ids.

**Outputs**

- `data` (object): Complete Smartlead response, including offset and total counts where returned.
- `has_more` (true/false): Whether the service reports another page.
- `next_cursor` (text): Cursor for the next page, when supplied by the service.

**Example output**

```json
{
  "data": null,
  "has_more": false,
  "next_cursor": ""
}
```

### Resume campaign lead

Resume campaign lead.

**Inputs**

- Campaign (`campaign_id`, number, required): Campaign id. At least 1.
- Lead ID (`lead_id`, number, required): Lead id. At least 1.
- Resume lead with delay days (`resume_lead_with_delay_days`, number): Resume lead with delay days.

**Outputs**

- `data` (object): Complete Smartlead response, including offset and total counts where returned.
- `has_more` (true/false): Whether the service reports another page.
- `next_cursor` (text): Cursor for the next page, when supplied by the service.

**Example output**

```json
{
  "data": null,
  "has_more": false,
  "next_cursor": ""
}
```

### Set campaign status

Set campaign status.

**Inputs**

- Campaign (`campaign_id`, number, required): Campaign id. At least 1.
- Status (`status`, text, required): Start or resume sending, pause, stop, or archive the campaign. Starting can send emails. One of: `START`, `PAUSED`, `STOPPED`, `ARCHIVED`.

**Outputs**

- `data` (object): Complete Smartlead response, including offset and total counts where returned.
- `has_more` (true/false): Whether the service reports another page.
- `next_cursor` (text): Cursor for the next page, when supplied by the service.

**Example output**

```json
{
  "data": null,
  "has_more": false,
  "next_cursor": ""
}
```

### Set sequences

Set sequences.

**Inputs**

- Campaign (`campaign_id`, number, required): Campaign id. At least 1.
- Sequences (`sequences`, list, required): Sequences.

**Outputs**

- `data` (object): Complete Smartlead response, including offset and total counts where returned.
- `has_more` (true/false): Whether the service reports another page.
- `next_cursor` (text): Cursor for the next page, when supplied by the service.

**Example output**

```json
{
  "data": null,
  "has_more": false,
  "next_cursor": ""
}
```

### Unsubscribe campaign lead

Unsubscribe campaign lead.

**Inputs**

- Campaign (`campaign_id`, number, required): Campaign id. At least 1.
- Lead ID (`lead_id`, number, required): Lead id. At least 1.

**Outputs**

- `data` (object): Complete Smartlead response, including offset and total counts where returned.
- `has_more` (true/false): Whether the service reports another page.
- `next_cursor` (text): Cursor for the next page, when supplied by the service.

**Example output**

```json
{
  "data": null,
  "has_more": false,
  "next_cursor": ""
}
```

### Update campaign lead

Update campaign lead.

**Inputs**

- Campaign (`campaign_id`, number, required): Campaign id. At least 1.
- Lead ID (`lead_id`, number, required): Lead id. At least 1.
- Email (`email`, text, required): Email.
- First name (`first_name`, text): First name.
- Last name (`last_name`, text): Last name.
- Company name (`company_name`, text): Company name.
- Phone number (`phone_number`, text): Phone number.
- Website (`website`, text): Website.
- Location (`location`, text): Location.
- Linkedin profile (`linkedin_profile`, text): Linkedin profile.
- Company URL (`company_url`, text): Company url.
- Custom fields (`custom_fields`, object): Custom fields.

**Outputs**

- `data` (object): Complete Smartlead response, including offset and total counts where returned.
- `has_more` (true/false): Whether the service reports another page.
- `next_cursor` (text): Cursor for the next page, when supplied by the service.

**Example output**

```json
{
  "data": null,
  "has_more": false,
  "next_cursor": ""
}
```

### Update campaign schedule

Update campaign schedule.

**Inputs**

- Campaign (`campaign_id`, number, required): Campaign id. At least 1.
- Timezone (`timezone`, text, required): Timezone.
- Days (`days`, list, required): Days. One or more of: `0` (Sunday), `1` (Monday), `2` (Tuesday), `3` (Wednesday), `4` (Thursday), `5` (Friday), `6` (Saturday).
- Start hour (`start_hour`, time, required): Start hour.
- End hour (`end_hour`, time, required): End hour.
- Min time btw emails (`min_time_btw_emails`, number): Min time btw emails.

**Outputs**

- `data` (object): Complete Smartlead response, including offset and total counts where returned.
- `has_more` (true/false): Whether the service reports another page.
- `next_cursor` (text): Cursor for the next page, when supplied by the service.

**Example output**

```json
{
  "data": null,
  "has_more": false,
  "next_cursor": ""
}
```

### Update campaign settings

Update campaign settings.

**Inputs**

- Campaign (`campaign_id`, number, required): Campaign id. At least 1.
- Name (`name`, text): Name.
- Track settings (`track_settings`, list): Track settings. One or more of: `DONT_TRACK_EMAIL_OPEN` (Disable open tracking), `DONT_TRACK_LINK_CLICK` (Disable link tracking), `DONT_TRACK_REPLY_TO_AN_EMAIL` (Disable reply tracking).
- Stop lead settings (`stop_lead_settings`, text): Stop lead settings. One of: `CLICK_ON_A_LINK`, `OPEN_AN_EMAIL`.
- Unsubscribe text (`unsubscribe_text`, text): Unsubscribe text.
- Send as plain text (`send_as_plain_text`, true/false): Send as plain text.
- Force plain text (`force_plain_text`, true/false): Force plain text.
- Follow up percentage (`follow_up_percentage`, number): Follow up percentage.
- Client ID (`client_id`, number): Client id.
- Enable AI esp matching (`enable_ai_esp_matching`, true/false): Enable ai esp matching.
- Auto pause domain leads on reply (`auto_pause_domain_leads_on_reply`, true/false): Auto pause domain leads on reply.
- Ignore ss mailbox sending limit (`ignore_ss_mailbox_sending_limit`, true/false): Ignore ss mailbox sending limit.
- Bounce autopause threshold (`bounce_autopause_threshold`, text): Bounce autopause threshold.
- Domain level rate limit (`domain_level_rate_limit`, true/false): Domain level rate limit.
- Out of office detection settings (`out_of_office_detection_settings`, object): Out of office detection settings.
- IgnoreOOOasReply (`ignoreOOOasReply`, true/false): Ignoreoooasreply.
- AutoReactivateOOO (`autoReactivateOOO`, true/false): Autoreactivateooo.
- ReactivateOOOwithDelay (`reactivateOOOwithDelay`, number): Reactivateooowithdelay.
- AutoCategorizeOOO (`autoCategorizeOOO`, true/false): Autocategorizeooo.
- Add unsubscribe tag (`add_unsubscribe_tag`, true/false): Add unsubscribe tag.
- AI categorisation options (`ai_categorisation_options`, list): Ai categorisation options.

**Outputs**

- `data` (object): Complete Smartlead response, including offset and total counts where returned.
- `has_more` (true/false): Whether the service reports another page.
- `next_cursor` (text): Cursor for the next page, when supplied by the service.

**Example output**

```json
{
  "data": null,
  "has_more": false,
  "next_cursor": ""
}
```
