Smartlead

App · 25 actions

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

Actions

ActionWhat it does
Add campaign email accountsAdd campaign email accounts.
Add campaign leadsAdd campaign leads.
Create campaignCreate campaign.
Delete campaignDelete campaign.
Get campaignGet campaign.
Get campaign analyticsGet campaign analytics.
Get campaign email accountsGet campaign email accounts.
Get campaign statisticsGet campaign statistics.
Get email accountGet email account.
Get leadGet lead.
Get lead historyGet lead history.
Get sequencesGet sequences.
List campaign leadsList campaign leads.
List campaignsList campaigns.
List email accountsList email accounts.
List lead categoriesList lead categories.
Pause campaign leadPause campaign lead.
Remove campaign email accountsRemove campaign email accounts.
Resume campaign leadResume campaign lead.
Set campaign statusSet campaign status.
Set sequencesSet sequences.
Unsubscribe campaign leadUnsubscribe campaign lead.
Update campaign leadUpdate campaign lead.
Update campaign scheduleUpdate campaign schedule.
Update campaign settingsUpdate campaign settings.

Add campaign email accounts

Add campaign email accounts.

Inputs

Campaigncampaign_idnumberRequired
Campaign id.At least 1.
Email account IDSemail_account_idslistRequired
Email account ids.

Outputs

dataobject
Complete Smartlead response, including offset and total counts where returned.
has_moretrue/false
Whether the service reports another page.
next_cursortext
Cursor for the next page, when supplied by the service.
Example output
{
  "data": null,
  "has_more": false,
  "next_cursor": ""
}

Add campaign leads

Add campaign leads.

Inputs

Campaigncampaign_idnumberRequired
Campaign id.At least 1.
Lead listlead_listlistRequired
Lead list.
Settingssettingsobject
Settings.

Outputs

dataobject
Complete Smartlead response, including offset and total counts where returned.
has_moretrue/false
Whether the service reports another page.
next_cursortext
Cursor for the next page, when supplied by the service.
Example output
{
  "data": null,
  "has_more": false,
  "next_cursor": ""
}

Create campaign

Create campaign.

Inputs

Namenametext
Name.
Client IDclient_idnumber
Client id.

Outputs

dataobject
Complete Smartlead response, including offset and total counts where returned.
has_moretrue/false
Whether the service reports another page.
next_cursortext
Cursor for the next page, when supplied by the service.
Example output
{
  "data": null,
  "has_more": false,
  "next_cursor": ""
}

Delete campaign

Delete campaign.

Inputs

Campaigncampaign_idnumberRequired
Campaign id.At least 1.

Outputs

dataobject
Complete Smartlead response, including offset and total counts where returned.
has_moretrue/false
Whether the service reports another page.
next_cursortext
Cursor for the next page, when supplied by the service.
Example output
{
  "data": null,
  "has_more": false,
  "next_cursor": ""
}

Get campaign

Get campaign.

Inputs

Campaigncampaign_idnumberRequired
Campaign id.At least 1.
Include tagsinclude_tagstext
Include tags.One of: true, false.

Outputs

dataobject
Complete Smartlead response, including offset and total counts where returned.
has_moretrue/false
Whether the service reports another page.
next_cursortext
Cursor for the next page, when supplied by the service.
Example output
{
  "data": null,
  "has_more": false,
  "next_cursor": ""
}

Get campaign analytics

Get campaign analytics.

Inputs

Campaigncampaign_idnumberRequired
Campaign id.At least 1.

Outputs

dataobject
Complete Smartlead response, including offset and total counts where returned.
has_moretrue/false
Whether the service reports another page.
next_cursortext
Cursor for the next page, when supplied by the service.
Example output
{
  "data": null,
  "has_more": false,
  "next_cursor": ""
}

Get campaign email accounts

Get campaign email accounts.

Inputs

Campaigncampaign_idnumberRequired
Campaign id.At least 1.
Include tagsinclude_tagstext
Include tags.One of: true, false.

Outputs

datalist
Every record on this page.
has_moretrue/false
Whether the service reports another page.
next_cursortext
Cursor for the next page, when supplied by the service.
Example output
{
  "data": [],
  "has_more": false,
  "next_cursor": ""
}

Get campaign statistics

Get campaign statistics.

Inputs

Campaigncampaign_idnumberRequired
Campaign id.At least 1.
Offsetoffsetnumber
Offset.At least 0.
Limitlimitnumber
Limit.From 1 to 100.
Email sequence numberemail_sequence_numbernumber
Email sequence number.
Email statusemail_statustext
Email status.
Sent time start datesent_time_start_datedate
Sent time start date.
Sent time end datesent_time_end_datedate
Sent time end date.

Outputs

dataobject
Complete Smartlead response, including offset and total counts where returned.
has_moretrue/false
Whether the service reports another page.
next_cursortext
Cursor for the next page, when supplied by the service.
Example output
{
  "data": null,
  "has_more": false,
  "next_cursor": ""
}

Get email account

Get email account.

Inputs

Email account IDemail_account_idnumberRequired
Email account id.At least 1.
Fetch campaignsfetch_campaignstext
Fetch campaigns.One of: true, false.

Outputs

dataobject
Complete Smartlead response, including offset and total counts where returned.
has_moretrue/false
Whether the service reports another page.
next_cursortext
Cursor for the next page, when supplied by the service.
Example output
{
  "data": null,
  "has_more": false,
  "next_cursor": ""
}

Get lead

Get lead.

Inputs

Lead IDlead_idnumberRequired
Lead id.At least 1.

Outputs

dataobject
Complete Smartlead response, including offset and total counts where returned.
has_moretrue/false
Whether the service reports another page.
next_cursortext
Cursor for the next page, when supplied by the service.
Example output
{
  "data": null,
  "has_more": false,
  "next_cursor": ""
}

Get lead history

Get lead history.

Inputs

Campaigncampaign_idnumberRequired
Campaign id.At least 1.
Lead IDlead_idnumberRequired
Lead id.At least 1.
Event time gtevent_time_gtdate and time
Event time gt.
Show plain text responseshow_plain_text_responsetrue/false
Show plain text response.

Outputs

dataobject
Complete Smartlead response, including offset and total counts where returned.
has_moretrue/false
Whether the service reports another page.
next_cursortext
Cursor for the next page, when supplied by the service.
Example output
{
  "data": null,
  "has_more": false,
  "next_cursor": ""
}

Get sequences

Get sequences.

Inputs

Campaigncampaign_idnumberRequired
Campaign id.At least 1.

Outputs

datalist
Every record on this page.
has_moretrue/false
Whether the service reports another page.
next_cursortext
Cursor for the next page, when supplied by the service.
Example output
{
  "data": [],
  "has_more": false,
  "next_cursor": ""
}

List campaign leads

List campaign leads.

Inputs

Campaigncampaign_idnumberRequired
Campaign id.At least 1.
Offsetoffsetnumber
Offset.At least 0.
Limitlimitnumber
Limit.From 1 to 100.
Created at gtcreated_at_gtdate and time
Created at gt.
Last sent time gtlast_sent_time_gtdate and time
Last sent time gt.
Event time gtevent_time_gtdate and time
Event time gt.
Statusstatustext
Status.One of: STARTED, INPROGRESS, COMPLETED, PAUSED, STOPPED.
Lead category IDlead_category_idnumber
Lead category id.
EmailStatusemailStatustext
Emailstatus.One of: is_opened, is_clicked, is_bounced, is_replied, is_unsubscribed, is_spam, is_accepted.

Outputs

dataobject
Complete Smartlead response, including offset and total counts where returned.
has_moretrue/false
Whether the service reports another page.
next_cursortext
Cursor for the next page, when supplied by the service.
Example output
{
  "data": null,
  "has_more": false,
  "next_cursor": ""
}

List campaigns

List campaigns.

Inputs

Client IDclient_idnumber
Client id.
Include tagsinclude_tagstext
Include tags.One of: true, false.

Outputs

datalist
Every record on this page.
has_moretrue/false
Whether the service reports another page.
next_cursortext
Cursor for the next page, when supplied by the service.
Example output
{
  "data": [],
  "has_more": false,
  "next_cursor": ""
}

List email accounts

List email accounts.

Inputs

Offsetoffsetnumber
Offset.At least 0.
Limitlimitnumber
Limit.From 1 to 100.
IsInUseisInUsetext
Isinuse.One of: true, false.
EmailWarmupStatusemailWarmupStatustext
Emailwarmupstatus.One of: ACTIVE, INACTIVE.
IsSmtpSuccessisSmtpSuccesstext
Issmtpsuccess.One of: true, false.
IsWarmupBlockedisWarmupBlockedtext
Iswarmupblocked.One of: true, false.
Espesptext
Esp.One of: GMAIL, OUTLOOK, SMTP.
Usernameusernametext
Username.
Client IDclient_idnumber
Client id.
Fetch campaignsfetch_campaignstext
Fetch campaigns.One of: true, false.

Outputs

datalist
Every record on this page.
has_moretrue/false
Whether the service reports another page.
next_cursortext
Cursor for the next page, when supplied by the service.
Example output
{
  "data": [],
  "has_more": false,
  "next_cursor": ""
}

List lead categories

List lead categories.

Inputs

None.

Outputs

datalist
Every record on this page.
has_moretrue/false
Whether the service reports another page.
next_cursortext
Cursor for the next page, when supplied by the service.
Example output
{
  "data": [],
  "has_more": false,
  "next_cursor": ""
}

Pause campaign lead

Pause campaign lead.

Inputs

Campaigncampaign_idnumberRequired
Campaign id.At least 1.
Lead IDlead_idnumberRequired
Lead id.At least 1.

Outputs

dataobject
Complete Smartlead response, including offset and total counts where returned.
has_moretrue/false
Whether the service reports another page.
next_cursortext
Cursor for the next page, when supplied by the service.
Example output
{
  "data": null,
  "has_more": false,
  "next_cursor": ""
}

Remove campaign email accounts

Remove campaign email accounts.

Inputs

Campaigncampaign_idnumberRequired
Campaign id.At least 1.
Email account IDSemail_account_idslistRequired
Email account ids.

Outputs

dataobject
Complete Smartlead response, including offset and total counts where returned.
has_moretrue/false
Whether the service reports another page.
next_cursortext
Cursor for the next page, when supplied by the service.
Example output
{
  "data": null,
  "has_more": false,
  "next_cursor": ""
}

Resume campaign lead

Resume campaign lead.

Inputs

Campaigncampaign_idnumberRequired
Campaign id.At least 1.
Lead IDlead_idnumberRequired
Lead id.At least 1.
Resume lead with delay daysresume_lead_with_delay_daysnumber
Resume lead with delay days.

Outputs

dataobject
Complete Smartlead response, including offset and total counts where returned.
has_moretrue/false
Whether the service reports another page.
next_cursortext
Cursor for the next page, when supplied by the service.
Example output
{
  "data": null,
  "has_more": false,
  "next_cursor": ""
}

Set campaign status

Set campaign status.

Inputs

Campaigncampaign_idnumberRequired
Campaign id.At least 1.
StatusstatustextRequired
Start or resume sending, pause, stop, or archive the campaign. Starting can send emails.One of: START, PAUSED, STOPPED, ARCHIVED.

Outputs

dataobject
Complete Smartlead response, including offset and total counts where returned.
has_moretrue/false
Whether the service reports another page.
next_cursortext
Cursor for the next page, when supplied by the service.
Example output
{
  "data": null,
  "has_more": false,
  "next_cursor": ""
}

Set sequences

Set sequences.

Inputs

Campaigncampaign_idnumberRequired
Campaign id.At least 1.
SequencessequenceslistRequired
Sequences.

Outputs

dataobject
Complete Smartlead response, including offset and total counts where returned.
has_moretrue/false
Whether the service reports another page.
next_cursortext
Cursor for the next page, when supplied by the service.
Example output
{
  "data": null,
  "has_more": false,
  "next_cursor": ""
}

Unsubscribe campaign lead

Unsubscribe campaign lead.

Inputs

Campaigncampaign_idnumberRequired
Campaign id.At least 1.
Lead IDlead_idnumberRequired
Lead id.At least 1.

Outputs

dataobject
Complete Smartlead response, including offset and total counts where returned.
has_moretrue/false
Whether the service reports another page.
next_cursortext
Cursor for the next page, when supplied by the service.
Example output
{
  "data": null,
  "has_more": false,
  "next_cursor": ""
}

Update campaign lead

Update campaign lead.

Inputs

Campaigncampaign_idnumberRequired
Campaign id.At least 1.
Lead IDlead_idnumberRequired
Lead id.At least 1.
EmailemailtextRequired
Email.
First namefirst_nametext
First name.
Last namelast_nametext
Last name.
Company namecompany_nametext
Company name.
Phone numberphone_numbertext
Phone number.
Websitewebsitetext
Website.
Locationlocationtext
Location.
Linkedin profilelinkedin_profiletext
Linkedin profile.
Company URLcompany_urltext
Company url.
Custom fieldscustom_fieldsobject
Custom fields.

Outputs

dataobject
Complete Smartlead response, including offset and total counts where returned.
has_moretrue/false
Whether the service reports another page.
next_cursortext
Cursor for the next page, when supplied by the service.
Example output
{
  "data": null,
  "has_more": false,
  "next_cursor": ""
}

Update campaign schedule

Update campaign schedule.

Inputs

Campaigncampaign_idnumberRequired
Campaign id.At least 1.
TimezonetimezonetextRequired
Timezone.
DaysdayslistRequired
Days.One or more of: 0 (Sunday), 1 (Monday), 2 (Tuesday), 3 (Wednesday), 4 (Thursday), 5 (Friday), 6 (Saturday).
Start hourstart_hourtimeRequired
Start hour.
End hourend_hourtimeRequired
End hour.
Min time btw emailsmin_time_btw_emailsnumber
Min time btw emails.

Outputs

dataobject
Complete Smartlead response, including offset and total counts where returned.
has_moretrue/false
Whether the service reports another page.
next_cursortext
Cursor for the next page, when supplied by the service.
Example output
{
  "data": null,
  "has_more": false,
  "next_cursor": ""
}

Update campaign settings

Update campaign settings.

Inputs

Campaigncampaign_idnumberRequired
Campaign id.At least 1.
Namenametext
Name.
Track settingstrack_settingslist
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 settingsstop_lead_settingstext
Stop lead settings.One of: CLICK_ON_A_LINK, OPEN_AN_EMAIL.
Unsubscribe textunsubscribe_texttext
Unsubscribe text.
Send as plain textsend_as_plain_texttrue/false
Send as plain text.
Force plain textforce_plain_texttrue/false
Force plain text.
Follow up percentagefollow_up_percentagenumber
Follow up percentage.
Client IDclient_idnumber
Client id.
Enable AI esp matchingenable_ai_esp_matchingtrue/false
Enable ai esp matching.
Auto pause domain leads on replyauto_pause_domain_leads_on_replytrue/false
Auto pause domain leads on reply.
Ignore ss mailbox sending limitignore_ss_mailbox_sending_limittrue/false
Ignore ss mailbox sending limit.
Bounce autopause thresholdbounce_autopause_thresholdtext
Bounce autopause threshold.
Domain level rate limitdomain_level_rate_limittrue/false
Domain level rate limit.
Out of office detection settingsout_of_office_detection_settingsobject
Out of office detection settings.
IgnoreOOOasReplyignoreOOOasReplytrue/false
Ignoreoooasreply.
AutoReactivateOOOautoReactivateOOOtrue/false
Autoreactivateooo.
ReactivateOOOwithDelayreactivateOOOwithDelaynumber
Reactivateooowithdelay.
AutoCategorizeOOOautoCategorizeOOOtrue/false
Autocategorizeooo.
Add unsubscribe tagadd_unsubscribe_tagtrue/false
Add unsubscribe tag.
AI categorisation optionsai_categorisation_optionslist
Ai categorisation options.

Outputs

dataobject
Complete Smartlead response, including offset and total counts where returned.
has_moretrue/false
Whether the service reports another page.
next_cursortext
Cursor for the next page, when supplied by the service.
Example output
{
  "data": null,
  "has_more": false,
  "next_cursor": ""
}

On this page