Smartlead
App · 25 actions
Manage Smartlead campaigns, sending schedules, sequences, leads and email accounts; read campaign analytics.
Actions
| Action | What it does |
|---|---|
| Add campaign email accounts | Add campaign email accounts. |
| Add campaign leads | Add campaign leads. |
| Create campaign | Create campaign. |
| Delete campaign | Delete campaign. |
| Get campaign | Get campaign. |
| Get campaign analytics | Get campaign analytics. |
| Get campaign email accounts | Get campaign email accounts. |
| Get campaign statistics | Get campaign statistics. |
| Get email account | Get email account. |
| Get lead | Get lead. |
| Get lead history | Get lead history. |
| Get sequences | Get sequences. |
| List campaign leads | List campaign leads. |
| List campaigns | List campaigns. |
| List email accounts | List email accounts. |
| List lead categories | List lead categories. |
| Pause campaign lead | Pause campaign lead. |
| Remove campaign email accounts | Remove campaign email accounts. |
| Resume campaign lead | Resume campaign lead. |
| Set campaign status | Set campaign status. |
| Set sequences | Set sequences. |
| Unsubscribe campaign lead | Unsubscribe campaign lead. |
| Update campaign lead | Update campaign lead. |
| Update campaign schedule | Update campaign schedule. |
| Update campaign settings | Update campaign settings. |
Add campaign email accounts
Add campaign email accounts.
Inputs
- Campaign
campaign_idnumberRequired - Campaign id.At least 1.
- Email account IDS
email_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
- Campaign
campaign_idnumberRequired - Campaign id.At least 1.
- Lead list
lead_listlistRequired - Lead list.
- Settings
settingsobject - 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
- Name
nametext - Name.
- Client ID
client_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
- Campaign
campaign_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
- Campaign
campaign_idnumberRequired - Campaign id.At least 1.
- Include tags
include_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
- Campaign
campaign_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
- Campaign
campaign_idnumberRequired - Campaign id.At least 1.
- Include tags
include_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
- Campaign
campaign_idnumberRequired - Campaign id.At least 1.
- Offset
offsetnumber - Offset.At least 0.
- Limit
limitnumber - Limit.From 1 to 100.
- Email sequence number
email_sequence_numbernumber - Email sequence number.
- Email status
email_statustext - Email status.
- Sent time start date
sent_time_start_datedate - Sent time start date.
- Sent time end date
sent_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 ID
email_account_idnumberRequired - Email account id.At least 1.
- Fetch campaigns
fetch_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 ID
lead_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
- Campaign
campaign_idnumberRequired - Campaign id.At least 1.
- Lead ID
lead_idnumberRequired - Lead id.At least 1.
- Event time gt
event_time_gtdate and time - Event time gt.
- Show plain text response
show_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
- Campaign
campaign_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
- Campaign
campaign_idnumberRequired - Campaign id.At least 1.
- Offset
offsetnumber - Offset.At least 0.
- Limit
limitnumber - Limit.From 1 to 100.
- Created at gt
created_at_gtdate and time - Created at gt.
- Last sent time gt
last_sent_time_gtdate and time - Last sent time gt.
- Event time gt
event_time_gtdate and time - Event time gt.
- Status
statustext - Status.One of:
STARTED,INPROGRESS,COMPLETED,PAUSED,STOPPED. - Lead category ID
lead_category_idnumber - Lead category id.
- EmailStatus
emailStatustext - 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 ID
client_idnumber - Client id.
- Include tags
include_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
- Offset
offsetnumber - Offset.At least 0.
- Limit
limitnumber - Limit.From 1 to 100.
- IsInUse
isInUsetext - Isinuse.One of:
true,false. - EmailWarmupStatus
emailWarmupStatustext - Emailwarmupstatus.One of:
ACTIVE,INACTIVE. - IsSmtpSuccess
isSmtpSuccesstext - Issmtpsuccess.One of:
true,false. - IsWarmupBlocked
isWarmupBlockedtext - Iswarmupblocked.One of:
true,false. - Esp
esptext - Esp.One of:
GMAIL,OUTLOOK,SMTP. - Username
usernametext - Username.
- Client ID
client_idnumber - Client id.
- Fetch campaigns
fetch_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
- Campaign
campaign_idnumberRequired - Campaign id.At least 1.
- Lead ID
lead_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
- Campaign
campaign_idnumberRequired - Campaign id.At least 1.
- Email account IDS
email_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
- Campaign
campaign_idnumberRequired - Campaign id.At least 1.
- Lead ID
lead_idnumberRequired - Lead id.At least 1.
- Resume lead with delay days
resume_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
- Campaign
campaign_idnumberRequired - Campaign id.At least 1.
- Status
statustextRequired - 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
- Campaign
campaign_idnumberRequired - Campaign id.At least 1.
- Sequences
sequenceslistRequired - 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
- Campaign
campaign_idnumberRequired - Campaign id.At least 1.
- Lead ID
lead_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
- Campaign
campaign_idnumberRequired - Campaign id.At least 1.
- Lead ID
lead_idnumberRequired - Lead id.At least 1.
- Email
emailtextRequired - Email.
- First name
first_nametext - First name.
- Last name
last_nametext - Last name.
- Company name
company_nametext - Company name.
- Phone number
phone_numbertext - Phone number.
- Website
websitetext - Website.
- Location
locationtext - Location.
- Linkedin profile
linkedin_profiletext - Linkedin profile.
- Company URL
company_urltext - Company url.
- Custom fields
custom_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
- Campaign
campaign_idnumberRequired - Campaign id.At least 1.
- Timezone
timezonetextRequired - Timezone.
- Days
dayslistRequired - Days.One or more of:
0(Sunday),1(Monday),2(Tuesday),3(Wednesday),4(Thursday),5(Friday),6(Saturday). - Start hour
start_hourtimeRequired - Start hour.
- End hour
end_hourtimeRequired - End hour.
- Min time btw emails
min_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
- Campaign
campaign_idnumberRequired - Campaign id.At least 1.
- Name
nametext - Name.
- Track settings
track_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 settings
stop_lead_settingstext - Stop lead settings.One of:
CLICK_ON_A_LINK,OPEN_AN_EMAIL. - Unsubscribe text
unsubscribe_texttext - Unsubscribe text.
- Send as plain text
send_as_plain_texttrue/false - Send as plain text.
- Force plain text
force_plain_texttrue/false - Force plain text.
- Follow up percentage
follow_up_percentagenumber - Follow up percentage.
- Client ID
client_idnumber - Client id.
- Enable AI esp matching
enable_ai_esp_matchingtrue/false - Enable ai esp matching.
- Auto pause domain leads on reply
auto_pause_domain_leads_on_replytrue/false - Auto pause domain leads on reply.
- Ignore ss mailbox sending limit
ignore_ss_mailbox_sending_limittrue/false - Ignore ss mailbox sending limit.
- Bounce autopause threshold
bounce_autopause_thresholdtext - Bounce autopause threshold.
- Domain level rate limit
domain_level_rate_limittrue/false - Domain level rate limit.
- Out of office detection settings
out_of_office_detection_settingsobject - Out of office detection settings.
- IgnoreOOOasReply
ignoreOOOasReplytrue/false - Ignoreoooasreply.
- AutoReactivateOOO
autoReactivateOOOtrue/false - Autoreactivateooo.
- ReactivateOOOwithDelay
reactivateOOOwithDelaynumber - Reactivateooowithdelay.
- AutoCategorizeOOO
autoCategorizeOOOtrue/false - Autocategorizeooo.
- Add unsubscribe tag
add_unsubscribe_tagtrue/false - Add unsubscribe tag.
- AI categorisation options
ai_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": ""
}