Jump to Content

Home Guides Recipes API Reference Changelog Discussions

API Reference

Home Guides Recipes API Reference Changelog Discussions

All

Pages

Start typing to search…

GEtting Started

Welcome!
Authentication
References
Rate Limits

campaign management

Create Campaignpost
Update Campaign Schedulepost
Update Campaign General Settingspost
Get Campaign By Idget
Save Campaign Sequencepost
List all Campaignsget
Patch campaign statuspost
Fetch Campaign Sequence By Campaign IDget
Fetch all Campaigns Using Lead IDget
Export data from a campaignget
Delete Campaigndel
[DEPRECATED] Fetch Campaign Analytics by Date rangeget
Get Campaign Sequence Analyticsget
Create Subsequencepost

LEad management

Move Leads to Inactive from All Leads Pagepost
Move leads to Inactive from Campaign lead list pageget
Push Leads/List to Campaignpost
Get leads- Campaign Overviewget
Get Lead Sequence Detailsget
List all leads by Campaign IDget
Fetch Lead Categoriesget
Fetch Lead by email addressget
Add leads to a campaign by IDpost
Resume Lead By Campaign IDpost
Pause Lead By Campaign IDpost
Delete Lead By Campaign IDdel
Unsubscribe/Pause Lead From Campaignpost
Unsubscribe Lead From All Campaignspost
Fetch All Leads From Entire Accountget
Fetch Leads From Global Block Listget
Add Lead/Domain to Global Block Listpost
Delete Lead/Domain to Global Block Listdel
Update lead using the Lead IDpost
Update a lead’s category based on their campaignpost
Fetch Lead Message History Based on Campaignget

Email Accounts

Create an Email Accountpost
Remove Email Account from a Campaigndel
Fetch all email accounts associated to a userget
List all email accounts per campaignget
Fetch Email Account By IDget
Add Email Account to a Campaignpost
Add/Update Warmup To Email Accountpost
Reconnect failed email accountspost
Fetch Warmup Stats By Email Account IDget
Update Email Account Tagpost
Update Email Accountpost
Fetch Messages for Email Accountpost
Bulk Fetch Messages for Multiple Email Accountspost
Email Accounts
Add Tags to Email Accountspost
Remove Tags from Email Accountsdel
Get Tag List by Email Addressespost

Campaign statistics

Fetch Campaign Statistics By Campaign IDget
Fetch Campaign Statistics By Campaign Id And Date Rangeget
Fetch campaign top level analyticsget
Fetch Campaign Top Level Analytics By Date Rangeget
Fetch Campaign Lead Statisticsget
Fetch Campaign Mailbox Statisticsget

Smart Delivery

Region wise Provider IDsget
Create a Manual Placement Testpost
Create an Automated Placement Testpost
Spam Test Detailsget
Delete Smart Delivery Tests in Bulkpost
Stop an Automated Smart Delivery Testput
List all Testspost
Provider wise reportpost
Geo wise reportpost
Sender Account wise reportget
Spam filter reportget
DKIM Detailsget
SPF Detailsget
rDNS reportget
Sender Account Listget
Blacklistsget
Domain Blacklistget
Spam Test Email Contentget
Spam test IP Blacklist Countget
Email reply headersget
Schedule history for Automated Testsget
IP detailsget
Mailbox Summaryget
Mailbox Count APIget
Get All Foldersget
Create Folderspost
Get folder by IDget
Delete folderdel

webhooks

Fetch Webhooks By Campaign IDget
- Capturing Email Replies
Add / Update Campaign Webhookpost
Delete Campaign Webhookdel
Get Webhooks Publish Summaryget
Retrigger Failed Eventspost

client management

Add Client To System (Whitelabel or not)post
Fetch all clientsget
Create New Client API Keypost
Get Clients API Keysget
Delete Client API Keydel
Reset Client API Keyput

Smart Senders

Get one-time password for an admin mailboxget
Auto Generate Mailboxes APIpost
Search Domainget
Get Vendorsget
Place Order APIpost
Get Purchased Domain List APIget
Get Order Details APIget

GLOBAL ANALYTICS

Get Campaign Listget
Get Client Listget
Get Month-wise Client Countget
Get Overall Statsget
Get Day-wise Overall Statsget
Get Day-wise Overall Stats by Sent Timeget
Get Day-wise Positive Reply Statsget
Get Day-wise Positive Reply Stats by Sent Timeget
Get Campaign Overall Statsget
Get Client Overall Statsget
Get Email-Id-wise Health Metricsget
Get Domain-wise Health Metricsget
Get Provider-wise Overall Performanceget
Get Team Board Overall Statsget
Get Lead Overall Statsget
Get Lead Category-wise Responseget
Get Leads Take for First Replyget
Get Follow-up Reply Rateget
Get Lead to Reply Timeget
Get Campaign Response Statsget
Get Campaign Status Statsget
Get Mailbox Overall Statsget

master inbox

Fetch Inbox Repliespost
Fetch Unread Repliespost
Fetch Snoozed Messagespost
Fetch Important Marked Messagespost
Fetch Scheduled Messagespost
Fetch Messages with Reminderspost
Fetched Archived Messagespost
Fetch Master Inbox Lead by IDget
Fetch Untracked Repliesget
Reply To Lead From Master Inbox via APIpost
Forward a Replypost
Update Lead Revenuepatch
Update Lead Categorypatch
Create Lead Taskpost
Create Lead Notepost
Block Domainspost
Resume Leadpatch
Change Read Statuspatch
Set Reminderpost
Push Lead To Subsequencepost
- Update Team Member To Leadpost

SMART PROSPECT

Get departmentsget
Get citiesget
Get countriesget
Get statesget
Get industriesget
Get sub-industriesget
Get head countsget
Get levelsget
Get revenue optionsget
Get companiesget
Get domainsget
Get job titlesget
Get keywordsget
Search contactspost
Fetch contactspost
Get contactspost
Review contactspatch
Get saved searchesget
Get recent searchesget
Get fetched searchesget
Save searchpost
Update saved searchput
Update fetched leadput
Get search analyticsget
Get reply analyticsget
Find emailspost

Powered by

Add Client To System (Whitelabel or not)

post

https://server.smartlead.ai/api/v1/client/save

This endpoint lets you add new clients to your system

Language

Credentials

Query