Jump to Content
Home
Guides
Recipes
API Reference
Changelog
Discussions
v1.0
v1.1
Log In
API Reference
Log In
v1.0
Home
Guides
Recipes
API Reference
Changelog
Discussions
References
All
Pages
Start typing to search…
JUMP TO
GEtting Started
Welcome!
Authentication
References
Rate Limits
campaign management
Create Campaign
post
Update Campaign Schedule
post
Update Campaign General Settings
post
Get Campaign By Id
get
Save Campaign Sequence
post
List all Campaigns
get
Patch campaign status
post
Fetch Campaign Sequence By Campaign ID
get
Fetch all Campaigns Using Lead ID
get
Export data from a campaign
get
Delete Campaign
del
[DEPRECATED] Fetch Campaign Analytics by Date range
get
Get Campaign Sequence Analytics
get
Create Subsequence
post
LEad management
Move Leads to Inactive from All Leads Page
post
Move leads to Inactive from Campaign lead list page
get
Push Leads/List to Campaign
post
Get leads- Campaign Overview
get
Get Lead Sequence Details
get
List all leads by Campaign ID
get
Fetch Lead Categories
get
Fetch Lead by email address
get
Add leads to a campaign by ID
post
Resume Lead By Campaign ID
post
Pause Lead By Campaign ID
post
Delete Lead By Campaign ID
del
Unsubscribe/Pause Lead From Campaign
post
Unsubscribe Lead From All Campaigns
post
Fetch All Leads From Entire Account
get
Fetch Leads From Global Block List
get
Add Lead/Domain to Global Block List
post
Delete Lead/Domain to Global Block List
del
Update lead using the Lead ID
post
Update a lead’s category based on their campaign
post
Fetch Lead Message History Based on Campaign
get
Email Accounts
Create an Email Account
post
Remove Email Account from a Campaign
del
Fetch all email accounts associated to a user
get
List all email accounts per campaign
get
Fetch Email Account By ID
get
Add Email Account to a Campaign
post
Add/Update Warmup To Email Account
post
Reconnect failed email accounts
post
Fetch Warmup Stats By Email Account ID
get
Update Email Account Tag
post
Update Email Account
post
Fetch Messages for Email Account
post
Bulk Fetch Messages for Multiple Email Accounts
post
Email Accounts
Add Tags to Email Accounts
post
Remove Tags from Email Accounts
del
Get Tag List by Email Addresses
post
Campaign statistics
Fetch Campaign Statistics By Campaign ID
get
Fetch Campaign Statistics By Campaign Id And Date Range
get
Fetch campaign top level analytics
get
Fetch Campaign Top Level Analytics By Date Range
get
Fetch Campaign Lead Statistics
get
Fetch Campaign Mailbox Statistics
get
Smart Delivery
Region wise Provider IDs
get
Create a Manual Placement Test
post
Create an Automated Placement Test
post
Spam Test Details
get
Delete Smart Delivery Tests in Bulk
post
Stop an Automated Smart Delivery Test
put
List all Tests
post
Provider wise report
post
Geo wise report
post
Sender Account wise report
get
Spam filter report
get
DKIM Details
get
SPF Details
get
rDNS report
get
Sender Account List
get
Blacklists
get
Domain Blacklist
get
Spam Test Email Content
get
Spam test IP Blacklist Count
get
Email reply headers
get
Schedule history for Automated Tests
get
IP details
get
Mailbox Summary
get
Mailbox Count API
get
Get All Folders
get
Create Folders
post
Get folder by ID
get
Delete folder
del
webhooks
Fetch Webhooks By Campaign ID
get
Capturing Email Replies
Add / Update Campaign Webhook
post
Delete Campaign Webhook
del
Get Webhooks Publish Summary
get
Retrigger Failed Events
post
client management
Add Client To System (Whitelabel or not)
post
Fetch all clients
get
Create New Client API Key
post
Get Clients API Keys
get
Delete Client API Key
del
Reset Client API Key
put
Smart Senders
Auto Generate Mailboxes API
post
Search Domain
get
Get Vendors
get
Place Order API
post
Get Purchased Domain List API
get
Get Order Details API
get
GLOBAL ANALYTICS
Get Campaign List
get
Get Client List
get
Get Month-wise Client Count
get
Get Overall Stats
get
Get Day-wise Overall Stats
get
Get Day-wise Overall Stats by Sent Time
get
Get Day-wise Positive Reply Stats
get
Get Day-wise Positive Reply Stats by Sent Time
get
Get Campaign Overall Stats
get
Get Client Overall Stats
get
Get Email-Id-wise Health Metrics
get
Get Domain-wise Health Metrics
get
Get Provider-wise Overall Performance
get
Get Team Board Overall Stats
get
Get Lead Overall Stats
get
Get Lead Category-wise Response
get
Get Leads Take for First Reply
get
Get Follow-up Reply Rate
get
Get Lead to Reply Time
get
Get Campaign Response Stats
get
Get Campaign Status Stats
get
Get Mailbox Overall Stats
get
master inbox
Fetch Inbox Replies
post
Fetch Unread Replies
post
Fetch Snoozed Messages
post
Fetch Important Marked Messages
post
Fetch Scheduled Messages
post
Fetch Messages with Reminders
post
Fetched Archived Messages
post
Fetch Master Inbox Lead by ID
get
Fetch Untracked Replies
get
Reply To Lead From Master Inbox via API
post
Forward a Reply
post
Update Lead Revenue
patch
Update Lead Category
patch
Create Lead Task
post
Create Lead Note
post
Block Domains
post
Resume Lead
patch
Change Read Status
patch
Set Reminder
post
Push Lead To Subsequence
post
Update Team Member To Lead
post
SMART PROSPECT
Get departments
get
Get cities
get
Get countries
get
Get states
get
Get industries
get
Get sub-industries
get
Get head counts
get
Get levels
get
Get revenue options
get
Get companies
get
Get domains
get
Get job titles
get
Get keywords
get
Search contacts
post
Fetch contacts
post
Get contacts
post
Review contacts
patch
Get saved searches
get
Get recent searches
get
Get fetched searches
get
Save search
post
Update saved search
put
Update fetched lead
put
Get search analytics
get
Get reply analytics
get
Find emails
post
Powered by
References
Ask AI
References to key terms used in this docs
