Jump to Content

Home Guides Recipes API Reference Changelog Discussions

API Reference

v1.0Home 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 Campaigndelete
Fetch Campaign Analytics by Date rangeget
Get Campaign Sequence Analyticsget

Email account managment

List all email accounts per campaignget
Add Email Account to a Campaignpost
Remove Email Account from a Campaigndelete
Fetch all email accounts associated to a userget
Create an Email Accountpost
Update Email Accountpost
Fetch Email Account By IDget
Add/Update Warmup To Email Accountpost
Reconnect failed email accountspost
Update Email Account Tagpost

LEad management

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 IDdelete
Unsubscribe/Pause Lead From Campaignpost
Unsubscribe Lead From All Campaignspost
Add Lead/Domain to Global Block Listpost
Fetch All Leads From Entire Accountget
Fetch Leads From Global Block Listget
Update lead using the Lead IDpost
Update a lead’s category based on their campaignpost
Fetch Lead Message History Based on Campaignget
Reply To Lead From Master Inbox via APIpost
Forward a Replypost

Campaign statistics

Fetch Campaign Statistics By Campaign IDget
Fetch Campaign Statistics By Campaign Id And Date Rangeget
Fetch Warmup Stats By Email Account IDget
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 folderdelete

webhooks

Fetch Webhooks By Campaign IDget
- Capturing Email Replies
Add / Update Campaign Webhookpost
Delete Campaign Webhookdelete
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 Keydelete
Reset Client API Keyput

Smart Senders

Search Domainget
Get Vendorsget
Auto-generate-mailboxespost
Place order for mailboxespost
Get Domain Listget

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

Powered by

Patch campaign status

post https://server.smartlead.ai/api/v1/campaigns/${}campaign_id{}/status

This endpoint changes the status of a campaign

Language

Credentials

Query