High-volume cold-email platform on isolated infrastructure with dedicated IPs. One flat plan ($599/mo for 500k sends) with unlimited leads, workspaces and teammates. Each customer gets its own instance and its own API base URL. Best for agencies and teams sending hundreds of thousands of emails a month that want dedicated IPs and no per-seat or per-lead fees.
The actions you pay for, as EmailBison prices them.
| Action | Cost |
|---|---|
| Account Details, This endpoint retrieves the details of the authenticated user. The user must provide a valid authentication token in the request header to access this endpoint. | counts against monthly send bucket only when emails are sent |
| Update Profile Picture, This endpoint allows the authenticated user to update their profile information, specifically their profile picture. The user must provide a valid authentication token in the request header to access | counts against monthly send bucket only when emails are sent |
| Update Password, This endpoint allows the authenticated user to update their password. The user must provide a valid authentication token in the request header to access this endpoint. | counts against monthly send bucket only when emails are sent |
| Generate headless UI token (deprecated), Note: this endpoint is deprecated and may not be supported. Please use the endpoints in the "OAuth Sessions" section instead. This endpoint allows the authenticated workspace user to generate a head | counts against monthly send bucket only when emails are sent |
| List campaigns, This route supports cursor pagination for faster processing. We recommend using this for traversing larger datasets. More info here: docs.emailbison.com/get-started/pagination | counts against monthly send bucket only when emails are sent |
| Create a campaign, This endpoint allows the authenticated user to create a new campaign. | counts against monthly send bucket only when emails are sent |
| Duplicate campaign, This endpoint allows the authenticated user to duplicate a campaign. | counts against monthly send bucket only when emails are sent |
| Pause campaign, This endpoint allows the authenticated user to pause a campaign. | counts against monthly send bucket only when emails are sent |
| Action | Cost |
|---|---|
| Resume campaign, This endpoint allows the authenticated user to resume a paused campaign. | counts against monthly send bucket only when emails are sent |
| Archive campaign, This endpoint allows the authenticated user to archive a campaign. | counts against monthly send bucket only when emails are sent |
| Update campaign settings, This endpoint allows the authenticated user to update the settings of a campaign. | counts against monthly send bucket only when emails are sent |
| Create campaign schedule, This endpoint allows the authenticated user to create the schedule of the campaign. | counts against monthly send bucket only when emails are sent |
| View campaign schedule, This endpoint allows the authenticated user to view the schedule of the campaign. | counts against monthly send bucket only when emails are sent |
| Update campaign schedule, This endpoint allows the authenticated user to update the schedule of the campaign. | counts against monthly send bucket only when emails are sent |
| View all schedule templates, This endpoint allows the authenticated user to view their scheduled templates. | counts against monthly send bucket only when emails are sent |
| View all available schedule timezones, This endpoint allows the authenticated user to view all available timezones. You must use an ID from this list whenever you're working on Campaign Schedules | counts against monthly send bucket only when emails are sent |
| Show sending schedules for campaigns, This endpoint allows the authenticated user to view the sending schedules for campaigns | counts against monthly send bucket only when emails are sent |
| Show sending schedule for campaign, This endpoint allows the authenticated user to view the sending schedule of a single campaign | counts against monthly send bucket only when emails are sent |
| Create campaign schedule from template, This endpoint allows the authenticated user to create the schedule of the campaign. | counts against monthly send bucket only when emails are sent |
| View campaign sequence steps (deprecated), This endpoint allows the authenticated user to view the sequence steps of the campaign. | counts against monthly send bucket only when emails are sent |
| Create sequence steps (deprecated), This endpoint allows the authenticated user to create the campaign sequence steps from scratch. | counts against monthly send bucket only when emails are sent |
| Update sequence steps (deprecated), This endpoint allows the authenticated user to update the campaign sequence steps. | counts against monthly send bucket only when emails are sent |
| Activate or deactivate a sequence step variant, This endpoint allows the authenticated user to activate or deactivate a sequence step variant. You can get a list of sequence step IDs by making a request to `/campaigns/v1.1/{campaign_id}/sequence-s | counts against monthly send bucket only when emails are sent |
| Delete sequence step, This endpoint allows the authenticated user to delete a specific sequence step from a sequence | counts against monthly send bucket only when emails are sent |
| Send sequence step test email, This endpoint allows the authenticated user to send a test email from a sequence step. You need at least one lead in the campaign to send a test email. | counts against monthly send bucket only when emails are sent |
| Get campaign replies, This endpoint retrieves all replies associated with a campaign. This route supports cursor pagination for faster processing. We recommend using this for traversing larger datasets. More info here: ht | counts against monthly send bucket only when emails are sent |
| Get all leads for campaign, This route supports cursor pagination for faster processing. We recommend using this for traversing larger datasets. More info here: docs.emailbison.com/get-started/pagination | counts against monthly send bucket only when emails are sent |
| Remove leads from a campaign, This endpoint allows the authenticated user to remove leads from a campaign. **Hold on. You may not need to remove leads!** Please read carefully before attempting to delete. **I mapped the wrong cu | counts against monthly send bucket only when emails are sent |
| Import leads from existing list, This endpoint allows the authenticated user to import leads from an existing list into a campaign. | counts against monthly send bucket only when emails are sent |
| Import leads by IDs, This endpoint allows the authenticated user to import leads by their IDs into a campaign. If you are adding leads to an active campaign, we cache them locally, and then sync every 5 minutes to ensure | free; leads added to an ACTIVE campaign are cached and synced every 5 minutes |
| Stop future emails for leads, This endpoint allows the authenticated user to stop future emails for selected leads in a campaign | counts against monthly send bucket only when emails are sent |
| Get all scheduled emails for campaign, This endpoint retrieves all scheduled emails associated with a campaign. This route supports cursor pagination for faster processing. We recommend using this for traversing larger datasets. More info | counts against monthly send bucket only when emails are sent |
| Get all campaign sender emails, This route supports cursor pagination for faster processing. We recommend using this for traversing larger datasets. More info here: docs.emailbison.com/get-started/pagination | counts against monthly send bucket only when emails are sent |
| Get campaign stats (summary), This endpoint retrieves the statistics of all your campaigns. | counts against monthly send bucket only when emails are sent |
| Import sender emails by ID, This endpoint allows the authenticated user to attach sender emails to a campaign. | counts against monthly send bucket only when emails are sent |
| Remove sender emails by ID, This endpoint allows the authenticated user to remove sender emails from a draft or paused campaign. | counts against monthly send bucket only when emails are sent |
| Move leads to another campaign, This endpoint moves selected leads from a campaign to a selected target campaign. This process may take a few minutes if the campaigns are active. | counts against monthly send bucket only when emails are sent |
| Get full normalized stats by date, This endpoint retrieves stats by date for a given period, for this campaign The user must provide a valid authentication token in the request header to access this endpoint. Events returned: `Replie | counts against monthly send bucket only when emails are sent |
| Campaign details, This endpoint retrieves the details of a specific campaign. | counts against monthly send bucket only when emails are sent |
| Bulk delete campaigns by ID, This endpoint allows the authenticated user to bulk delete campaigns. Campaign deletion is queued up and processed in the background. *Overall stats and lead conversations will not be affected** You | counts against monthly send bucket only when emails are sent |
| Delete a campaign, This endpoint allows the authenticated user to delete a campaign. Campaign deletion is queued up and processed in the background. **Overall stats and lead conversations will not be affected** You wil | counts against monthly send bucket only when emails are sent |
| Get all replies, This route supports cursor pagination for faster processing. We recommend using this for traversing larger datasets. More info here: docs.emailbison.com/get-started/pagination | counts against monthly send bucket only when emails are sent |
| Get reply, This endpoint retrieves a specific reply by its ID. The user must provide a valid authentication token in the request header to access this endpoint. | counts against monthly send bucket only when emails are sent |
| Compose new email, This endpoint allows you to send a one-off email in a new email thread The user must provide a valid authentication token in the request header to access this endpoint. Please note that if you are s | counts against monthly send bucket only when emails are sent |
| Create new reply, This endpoint allows you to reply to an existing email. The user must provide a valid authentication token in the request header to access this endpoint. Please note that if you are sending an array | counts against monthly send bucket only when emails are sent |
| Forward reply, This endpoint allows you to forward an existing reply. The user must provide a valid authentication token in the request header to access this endpoint. Please note that if you are sending an array | counts against monthly send bucket only when emails are sent |
| Mark as interested, This endpoint marks a specific reply as interested. If a particular lead is already marked as "interested" within a campaign, no changes will be made. The user must provide a valid authentication tok | counts against monthly send bucket only when emails are sent |
| Mark as not interested, This endpoint marks a specific reply as not interested. The user must provide a valid authentication token in the request header to access this endpoint. | counts against monthly send bucket only when emails are sent |
| Mark as read or unread, This endpoint marks a specific reply as read or unread. The user must provide a valid authentication token in the request header to access this endpoint. | counts against monthly send bucket only when emails are sent |
| Mark as automated or not automated, This endpoint marks a specific reply as automated or not automated. The user must provide a valid authentication token in the request header to access this endpoint. | counts against monthly send bucket only when emails are sent |
| Unsubscribe contact that replied, This endpoint unsubscribes the contact associated with a specific reply from scheduled emails. The user must provide a valid authentication token in the request header to access this endpoint. | counts against monthly send bucket only when emails are sent |
| Delete reply, This endpoint deletes a specific reply by its ID. The user must provide a valid authentication token in the request header to access this endpoint. | counts against monthly send bucket only when emails are sent |
| Get reply conversation thread, This endpoint gets you a reply object with all previous and newer messages to build out an email thread The user must provide a valid authentication token in the request header to access this endpoin | counts against monthly send bucket only when emails are sent |
| Attach scheduled email to reply, This endpoint attaches a scheduled email to a reply (and lead). You can use this for untracked replies where headers may have been missing when the email was received. This will take care of increment | counts against monthly send bucket only when emails are sent |
| Push reply (and lead) to "reply followup campaign", This endpoint lets you push a reply to a "reply followup campaign" The goal is to followup with interested leads in a templated, automated manner. Followups are done in the same conversation thread, a | counts against monthly send bucket only when emails are sent |
| List email accounts, Retrieves a collection of email accounts associated with the authenticated workspace. This route supports cursor pagination for faster processing. We recommend using this for traversing larger datase | counts against monthly send bucket only when emails are sent |
| Show Email Account Campaigns, Retrieves a collection of campaigns where this email account is being used | counts against monthly send bucket only when emails are sent |
| Show email account details, Retrieves details of a specific email account. | counts against monthly send bucket only when emails are sent |
| Update sender email, Update the settings for a specified sender email. | counts against monthly send bucket only when emails are sent |
| Delete email account, Add multiple sender email addresses at once. | counts against monthly send bucket only when emails are sent |
| Get email account replies, This endpoint retrieves all replies associated with a given email account This route supports cursor pagination for faster processing. We recommend using this for traversing larger datasets. More inf | counts against monthly send bucket only when emails are sent |
| Get email account oAuth access token, This endpoint retrieves the OAuth access token for a sender email account (Google or Microsoft accounts only). If a token has expired, a new one is automatically retrieved and returned using the save | counts against monthly send bucket only when emails are sent |
| Bulk update email signatures, Update the signatures of multiple sender emails at once. | counts against monthly send bucket only when emails are sent |
| Bulk update email daily limits, Update the daily sending limit of multiple sender emails at once. | counts against monthly send bucket only when emails are sent |
| Create IMAP/SMTP Email Account, Creates a new IMAP/SMTP email account for the authenticated workspace. | counts against monthly send bucket only when emails are sent |
| Bulk add sender emails, Add multiple sender email addresses at once. | counts against monthly send bucket only when emails are sent |
| Check MX records, Checks the email host for a given email address and returns the host + all MX records. Results are not cached, and if a valid return is returned, the Sender Email account will be updated. | counts against monthly send bucket only when emails are sent |
| Bulk check missing MX records, This endpoint lets you trigger a job that will bulk check all email accounts with missing MX records in the given workspace. | counts against monthly send bucket only when emails are sent |
Move sender email to another workspace, This endpoint moves a sender email to a different workspace. Note: this endpoint requires a super-admin token that has access to the target workspace. | counts against monthly send bucket only when emails are sent |
Move sender emails to another workspace (bulk), This endpoint bulk moves sender emails to a different workspace. Note: this endpoint requires a super-admin token that has access to the target workspace. | counts against monthly send bucket only when emails are sent |
| Get all blacklisted emails, This route supports cursor pagination for faster processing. We recommend using this for traversing larger datasets. More info here: docs.emailbison.com/get-started/pagination | counts against monthly send bucket only when emails are sent |
| Create blacklisted email, Add a new email to the blacklist. | counts against monthly send bucket only when emails are sent |
| Get blacklisted email, Get a single blacklisted email by email or ID. | counts against monthly send bucket only when emails are sent |
| Remove blacklisted email, Remove an email from the blacklist. | counts against monthly send bucket only when emails are sent |
| Bulk create blacklisted emails, Add multiple emails to the blacklist in a single request. | counts against monthly send bucket only when emails are sent |
| Get all blacklisted domains, Retrieve a list of all blacklisted domains for the authenticated user. | counts against monthly send bucket only when emails are sent |
| Create blacklisted domain, Add a new domain to the blacklist. | counts against monthly send bucket only when emails are sent |
| Get blacklisted domain, Get a single blacklisted domain by domain or ID. | counts against monthly send bucket only when emails are sent |
| Remove blacklisted domain, Remove a domain from the blacklist. | counts against monthly send bucket only when emails are sent |
| Bulk create blacklisted domains, Add multiple domains to the blacklist in a single request. | counts against monthly send bucket only when emails are sent |
| Get all tags for workspace, Retrieve a list of all tags for the authenticated user's workspace. | counts against monthly send bucket only when emails are sent |
| Create tag, Add a new tag. | counts against monthly send bucket only when emails are sent |
| View tag, View a saved tag. | counts against monthly send bucket only when emails are sent |
| Remove tag, Delete a tag. | counts against monthly send bucket only when emails are sent |
| Attach tags to campaigns, Attach multiple tags to campaigns. | counts against monthly send bucket only when emails are sent |
| Remove tags from campaigns, Detach multiple tags from campaigns. | counts against monthly send bucket only when emails are sent |
| Attach tags to leads, Attach multiple tags to leads. | counts against monthly send bucket only when emails are sent |
| Remove tags from leads, Detach multiple tags from leads. | counts against monthly send bucket only when emails are sent |
| Attach tags to email accounts, Attach multiple tags to email accounts | counts against monthly send bucket only when emails are sent |
| Remove tags from email accounts, Detach multiple tags from email accounts | counts against monthly send bucket only when emails are sent |
| Get all custom tracking domains, Retrieve a list of all custom tracking domains for the authenticated user. | counts against monthly send bucket only when emails are sent |
| Create custom tracking domain, Add a new custom tracking domain to the authenticated user's team. | counts against monthly send bucket only when emails are sent |
| Get a custom tracking domains, View a custom tracking domains. | counts against monthly send bucket only when emails are sent |
| Remove custom tracking domain, Delete a custom tracking domain. | counts against monthly send bucket only when emails are sent |
| Breakdown of events by date, This endpoint retrieves stats by date for a given period, for this campaign Drill down into campaign event stats based on dates, campaign IDs, and/or sender email IDs The user must provide a valid a | counts against monthly send bucket only when emails are sent |
| View campaign sequence steps (v1.1), This endpoint allows the authenticated user to view the sequence steps of the campaign. | counts against monthly send bucket only when emails are sent |
| Create sequence steps (v1.1), This endpoint allows the authenticated user to create the campaign sequence steps from scratch. | counts against monthly send bucket only when emails are sent |
| Update sequence steps (v1.1), This endpoint allows the authenticated user to update the campaign sequence steps. | counts against monthly send bucket only when emails are sent |
| Get all custom variables, Retrieve a list of all custom variables for your workspace | counts against monthly send bucket only when emails are sent |
| Create a new custom variable, Add a new custom variable for your workspace | counts against monthly send bucket only when emails are sent |
| Remove custom variable, Delete a custom variable. | counts against monthly send bucket only when emails are sent |
| Get all events (up to 10 days), This route only supports cursor pagination due to large data sets. More info here: docs.emailbison.com/get-started/pagination This endpoint retrieves all event | counts against monthly send bucket only when emails are sent |
| Get event, This endpoint retrieves a specific event by its ID. The user must provide a valid authentication token in the request header to access this endpoint. | counts against monthly send bucket only when emails are sent |
| Get all ignore phrases, Retrieve a list of all ignore phrases for the authenticated user. | counts against monthly send bucket only when emails are sent |
| Create ignore phrase, Add a new ignore phrase | counts against monthly send bucket only when emails are sent |
| Get single ignore phrase, Retrieve the details of a specific ignore phrase | counts against monthly send bucket only when emails are sent |
| Remove ignore phrase, Remove an ignore phrase | counts against monthly send bucket only when emails are sent |
| Get all lead lists for workspace, Retrieve a paginated list of all lead lists for the authenticated user's workspace. | counts against monthly send bucket only when emails are sent |
| Create lead list, Add a new lead list. | counts against monthly send bucket only when emails are sent |
| View lead list, View a single lead list. | counts against monthly send bucket only when emails are sent |
| Rename lead list, Update the name of an existing lead list. | counts against monthly send bucket only when emails are sent |
| Get all leads, Retrieve a list of all leads for the authenticated user. This route supports cursor pagination for faster processing. We recommend using this for traversing larger datasets. More info here: https://d | counts against monthly send bucket only when emails are sent |
| Create lead, Create a single lead (contact) record | counts against monthly send bucket only when emails are sent |
| Get single lead, Retrieve the details of a specific lead | counts against monthly send bucket only when emails are sent |
| Update lead, Update the details of a specific lead Fields passed in the request will be updated. Fields and custom variables not passed will be cleared. | counts against monthly send bucket only when emails are sent |
| Update lead, Update the details of a specific lead Fields passed in the request will be updated. Fields and custom variables not passed will remain unchanged. | counts against monthly send bucket only when emails are sent |
| Delete a lead, Permanently delete a lead and its associated data **Hold on. You may not need to delete leads.** You may be able to simply re-upload leads instead **I mapped the wrong custom variables for these lea | counts against monthly send bucket only when emails are sent |
| Get all replies for lead, This endpoint retrieves all replies for a specific lead The user must provide a valid authentication token in the request header to access this endpoint. This route supports cursor pagination for fa | counts against monthly send bucket only when emails are sent |
| Bulk create leads, Create multiple lead records in a single request (limit 500 per request) Personal domains will be skipped unless enabled on your instance. get in touch with support if you want to send to personal do | free (unlimited lead storage); limit 500 leads per request; personal domains (gmail etc.) skipped unless enabled on instance |
| Bulk update lead status, Bulk update the status of multiple selected leads | counts against monthly send bucket only when emails are sent |
| Update or create multiple leads, Update or create multiple lead records in a single request (limit 500 per request). Personal domains will be skipped unless enabled on your instance. get in touch with support if you want to send to | free; limit 500 leads per request; personal domains skipped unless enabled |
| Update or create lead, Update the details of a specific lead if it exists, otherwise create a new record | counts against monthly send bucket only when emails are sent |
| Unsubscribe lead, Unsubscribe a lead from scheduled emails. | counts against monthly send bucket only when emails are sent |
| Add lead to blacklist, Add a lead to your global blacklist. | counts against monthly send bucket only when emails are sent |
| Bulk create leads using CSV, Create multiple leads in a single request using a CSV | counts against monthly send bucket only when emails are sent |
Get all scheduled emails, Retrieves a collection of scheduled emails associated with a lead. These scheduled emails
can have multiple statuses including: scheduled, sending paused, stopped, bounced, unsubscribed, `re | counts against monthly send bucket only when emails are sent |
| Get all sent emails for a lead, Retrieves a collection of **sent** campaign emails associated with a lead on the authenticated workspace. | counts against monthly send bucket only when emails are sent |
| Update lead status, Update the status of a lead | counts against monthly send bucket only when emails are sent |
| Bulk delete leads by ID, Permanently delete leads and associated data **Hold on. You may not need to delete leads.** You may be able to simply re-upload leads instead **I mapped the wrong custom variables for these leads* | counts against monthly send bucket only when emails are sent |
| View oAuth Session, This endpoint allows the authenticated user to view an oAuth session. You can use this endpoint to check the status of the session. Possible statues are: pending, expired, success, failure. | counts against monthly send bucket only when emails are sent |
| Create Microsoft oAuth Session, This endpoint creates a Microsoft oAuth session, valid for 10 minutes. Note: this endpoint has a limit of 60 requests per minute. | counts against monthly send bucket only when emails are sent |
| Create Google oAuth Session, This endpoint creates a Google oAuth session, valid for 10 minutes. Note: this endpoint has a limit of 60 requests per minute. | counts against monthly send bucket only when emails are sent |
| Get all reply templates, This endpoint retrieves all reply templates for the current workspace The user must provide a valid authentication token in the request header to access this endpoint | counts against monthly send bucket only when emails are sent |
| Create a reply template, This endpoint allows the authenticated user to create a new reply template | counts against monthly send bucket only when emails are sent |
| Reply template details | counts against monthly send bucket only when emails are sent |
| Update a reply template, This endpoint allows the authenticated user to update an existing reply template. It will override the entire previous reply template, including attachments | counts against monthly send bucket only when emails are sent |
| Delete reply template, This endpoint will permanently delete the specified reply template | counts against monthly send bucket only when emails are sent |
| Get all scheduled emails, This route supports cursor pagination for faster processing. We recommend using this for traversing larger datasets. More info here: docs.emailbison.com/get-started/pagination | counts against monthly send bucket only when emails are sent |
| Get scheduled email, This endpoint retrieves a single scheduled (campaign) email. | counts against monthly send bucket only when emails are sent |
| List email accounts with warmup stats, This route supports cursor pagination for faster processing. We recommend using this for traversing larger datasets. More info here: docs.emailbison.com/get-started/pagination | counts against monthly send bucket only when emails are sent |
| Enable warmup for email accounts, This endpoint enables warmup for all the selected email accounts | counts against monthly send bucket only when emails are sent |
| Disable warmup for email accounts, This endpoint disables warmup for all the selected email accounts | counts against monthly send bucket only when emails are sent |
| Update daily warmup limits for email accounts, This endpoint updates the daily warmup limits for selected email accounts | counts against monthly send bucket only when emails are sent |
| Show single email account with warmup details, Retrieves a single email account (sender email) with its warmup details | counts against monthly send bucket only when emails are sent |
| Get webhook attempt, This endpoint retrieves a specific webhook attempt by its ID. The user must provide a valid authentication token in the request header to access this endpoint. | counts against monthly send bucket only when emails are sent |
| Retry webhook attempt, This endpoint retries a specific webhook attempt by its ID. You can retry failed or successful attempts. The user must provide a valid authentication token in the request header to access this endpoi | counts against monthly send bucket only when emails are sent |
| Get webhook delivery, This endpoint retrieves a specific webhook delivery by its ID. The user must provide a valid authentication token in the request header to access this endpoint. | counts against monthly send bucket only when emails are sent |
| Get sample webhook event payload | counts against monthly send bucket only when emails are sent |
| Get all webhook event types, Shows you a list of all valid webhook event types that are supported | counts against monthly send bucket only when emails are sent |
| Send a test webhook event, Send a test webhook for a chosen event type | counts against monthly send bucket only when emails are sent |
| Get all webhooks, Retrieve a list of all webhooks for the authenticated user's workspace. | counts against monthly send bucket only when emails are sent |
| Create a new webhook, Store a new webhook for the authenticated user's workspace. Provide an array of events to associate with the webhook; the events included in the array will be enabled. | counts against monthly send bucket only when emails are sent |
| Get a single webhook, Get the details of a specific webhook. | counts against monthly send bucket only when emails are sent |
| Update a webhook, Modify an existing webhook's details. Send an array of events to modify the webhook; the events included will be enabled, and those not included will be disabled. | counts against monthly send bucket only when emails are sent |
| Delete a webhook, Remove a webhook url by its ID. | counts against monthly send bucket only when emails are sent |
| List Workspaces, This endpoint retrieves all of the authenticated user's workspaces. The user must provide a valid authentication token in the request header to access this endpoint. | counts against monthly send bucket only when emails are sent |
| Create Workspace, This endpoint allows the authenticated user to create a new workspace. The user must provide a valid authentication token in the request header and the details of the new workspace in the request bod | counts against monthly send bucket only when emails are sent |
| Switch Workspace, This endpoint allows the authenticated user to switch to a different workspace. The user must provide a valid authentication token in the request header and the ID of the target workspace in the requ | counts against monthly send bucket only when emails are sent |
| Update Workspace, This endpoint allows the authenticated user to update their workspace information, specifically the workspace name. The user must provide a valid authentication token in the request header and the ID | counts against monthly send bucket only when emails are sent |
| Workspace Details, This endpoint retrieves the details of the authenticated user's workspace. The user must provide a valid authentication token in the request header to access this endpoint. | counts against monthly send bucket only when emails are sent |
| Invite Team Member, This endpoint allows the authenticated user to invite a new member to their team. The user must provide a valid authentication token in the request header and the email and role of the new team membe | counts against monthly send bucket only when emails are sent |
| Accept Workspace Invitation, This endpoint allows the user to accept an invitation to join a workspace. The user must provide a valid authentication token in the request header and the ID of the workspace invitation. | counts against monthly send bucket only when emails are sent |
| Update Workspace Member, This endpoint allows the authenticated user to update the role of a workspace member. The user must provide a valid authentication token in the request header and the ID of the workspace member and t | counts against monthly send bucket only when emails are sent |
| Delete Workspace Member, This endpoint allows the authenticated user to remove a workspace member. The user must provide a valid authentication token in the request header and the ID of the workspace member. | counts against monthly send bucket only when emails are sent |
| List Workspaces, This endpoint retrieves all of the authenticated user's workspaces. The user must provide a valid authentication token in the request header to access this endpoint. | counts against monthly send bucket only when emails are sent |
| Create Workspace, This endpoint allows the authenticated user to create a new workspace. The user must provide a valid authentication token in the request header and the details of the new workspace in the request bod | counts against monthly send bucket only when emails are sent |
| Create User (and add to workspace), This endpoint provides a convenient way to create a new user on your instance, and add them to the current workspace. This provides an alternate flow where you want to mass create users. If you simpl | counts against monthly send bucket only when emails are sent |
| Create API token for workspace, This endpoint lets you create an API token for a given workspace Requires a "super admin" API token | counts against monthly send bucket only when emails are sent |
| Switch Workspace, This endpoint allows the authenticated user to switch to a different workspace. The user must provide a valid authentication token in the request header and the ID of the target workspace in the requ | counts against monthly send bucket only when emails are sent |
| Delete Workspace, This endpoint allows the authenticated user to delete a workspace. The user must provide a valid super-admin authentication token in the request header and the ID of the target workspace in the query | counts against monthly send bucket only when emails are sent |
| Update Workspace, This endpoint allows the authenticated user to update their workspace information, specifically the workspace name. The user must provide a valid authentication token in the request header and the ID | counts against monthly send bucket only when emails are sent |
| Workspace Details, This endpoint retrieves the details of the authenticated user's workspace. The user must provide a valid authentication token in the request header to access this endpoint. | counts against monthly send bucket only when emails are sent |
| Invite Team Member, This endpoint allows the authenticated user to invite a new member to their team. The user must provide a valid authentication token in the request header and the email and role of the new team membe | counts against monthly send bucket only when emails are sent |
| Accept Workspace Invitation, This endpoint allows the user to accept an invitation to join a workspace. The user must provide a valid authentication token in the request header and the ID of the workspace invitation. | counts against monthly send bucket only when emails are sent |
| Update Workspace Member Role, This endpoint allows the authenticated user to update the role of a workspace member. The user must provide a valid authentication token in the request header and the ID of the workspace member and t | counts against monthly send bucket only when emails are sent |
| Delete Workspace Member, This endpoint allows the authenticated user to remove a workspace member. This does not delete the user account. It only removes them from the workspace. The user must provide a valid authentication | counts against monthly send bucket only when emails are sent |
| Get Master Inbox Settings, This endpoint retrieves the master inbox settings for this workspace. The user must provide a valid authentication token in the request header to access this endpoint. | counts against monthly send bucket only when emails are sent |
| Update Master Inbox Settings, This endpoint updates the master inbox settings for this workspace. The user must provide a valid authentication token in the request header to access this endpoint. | counts against monthly send bucket only when emails are sent |
| Get workspace stats (summary), This endpoint retrieves overall stats for this workspace between two given dates. The user must provide a valid authentication token in the request header to access this endpoint. | counts against monthly send bucket only when emails are sent |
Get full normalized stats by date, This endpoint retrieves stats by date for a given period The user must provide a valid authentication token in the request header to access this endpoint. Events returned: Replied, Total Opens | counts against monthly send bucket only when emails are sent |
US dollars, as EmailBison's pricing page shows them on 25 Oct 2026. Monthly and annual billing are shown apart.
$599/mo
billed monthly
500,000 emails per month; unlimited leads, workspaces and teammates; isolated network with dedicated IPs; warmup; API; private Slack support
buy additional monthly send buckets (price not published)
Limits apply per API key; numbers are not published.
Exceeding them returns 429 {"error":"rate_limited","retry_after":<seconds>}; retry after the window indicated by headers. Neither the docs nor the OpenAPI spec give figures. Paginated list endpoints return 15 records per page (data/links/meta).
EmailBison uses API key. The steps below follow EmailBison's own docs.
curl -X GET "https://send/api/users" \
-H "Authorization: Bearer $EMAILBISON_API_KEY"| What | Where |
|---|---|
| Documentation | docs.emailbison.com/get-started/introduction |
| API reference | dedi.emailbison.com/api/reference |
| OpenAPI spec | dedi.emailbison.com/api/reference.openapi |
| llms.txt | docs.emailbison.com/llms.txt |
| Base URL | https://send |
Other Email sending tools in this directory, each with its own review.
Best for multi-sender LinkedIn campaigns with automatic sender rotation and hard per-account limits.
HeyReach API reviewBest for integrating with an enterprise customer's existing Outreach org.
Outreach API reviewBest for multi-account LinkedIn outreach where you want to rent extra sender profiles natively.
Aimfox API reviewFour things to settle first, each read off EmailBison's own pages.
Tell us what you want EmailBison to do in your stack. We will show you how we would wire it into your data, outbound or CRM, and what we would check first.
Read from emailbison.com/pricing, dedi.emailbison.com/api/reference and emailbison.com/developers. Verified 25 Oct 2026.
| Method | Path | What it does | Cost |
|---|---|---|---|
| GET | /api/users | Account Details, This endpoint retrieves the details of the authenticated user. The user must provide a valid authentication token in the request header to access this endpoint. | counts against monthly send bucket only when emails are sent |
| POST | /api/users/profile-picture | Update Profile Picture, This endpoint allows the authenticated user to update their profile information, specifically their profile picture. The user must provide a valid authentication token in the request header to access | counts against monthly send bucket only when emails are sent |
| PUT | /api/users/password | Update Password, This endpoint allows the authenticated user to update their password. The user must provide a valid authentication token in the request header to access this endpoint. | counts against monthly send bucket only when emails are sent |
| POST | /api/users/headless-ui-token | Generate headless UI token (deprecated), Note: this endpoint is deprecated and may not be supported. Please use the endpoints in the "OAuth Sessions" section instead. This endpoint allows the authenticated workspace user to generate a head | counts against monthly send bucket only when emails are sent |
| GET | /api/campaigns | List campaigns, This route supports cursor pagination for faster processing. We recommend using this for traversing larger datasets. More info here: https://docs.emailbison.com/get-started/pagination#how-does-cursor- | counts against monthly send bucket only when emails are sent |
| POST | /api/campaigns | Create a campaign, This endpoint allows the authenticated user to create a new campaign. | counts against monthly send bucket only when emails are sent |
| POST | /api/campaigns/{campaign_id}/duplicate | Duplicate campaign, This endpoint allows the authenticated user to duplicate a campaign. | counts against monthly send bucket only when emails are sent |
| PATCH | /api/campaigns/{campaign_id}/pause | Pause campaign, This endpoint allows the authenticated user to pause a campaign. | counts against monthly send bucket only when emails are sent |
| PATCH | /api/campaigns/{campaign_id}/resume | Resume campaign, This endpoint allows the authenticated user to resume a paused campaign. | counts against monthly send bucket only when emails are sent |
| PATCH | /api/campaigns/{campaign_id}/archive | Archive campaign, This endpoint allows the authenticated user to archive a campaign. | counts against monthly send bucket only when emails are sent |
| PATCH | /api/campaigns/{id}/update | Update campaign settings, This endpoint allows the authenticated user to update the settings of a campaign. | counts against monthly send bucket only when emails are sent |
| POST | /api/campaigns/{campaign_id}/schedule | Create campaign schedule, This endpoint allows the authenticated user to create the schedule of the campaign. | counts against monthly send bucket only when emails are sent |
| GET | /api/campaigns/{campaign_id}/schedule | View campaign schedule, This endpoint allows the authenticated user to view the schedule of the campaign. | counts against monthly send bucket only when emails are sent |
| PUT | /api/campaigns/{campaign_id}/schedule | Update campaign schedule, This endpoint allows the authenticated user to update the schedule of the campaign. | counts against monthly send bucket only when emails are sent |
| GET | /api/campaigns/schedule/templates | View all schedule templates, This endpoint allows the authenticated user to view their scheduled templates. | counts against monthly send bucket only when emails are sent |
| GET | /api/campaigns/schedule/available-timezones | View all available schedule timezones, This endpoint allows the authenticated user to view all available timezones. You must use an ID from this list whenever you're working on Campaign Schedules | counts against monthly send bucket only when emails are sent |
| GET | /api/campaigns/sending-schedules | Show sending schedules for campaigns, This endpoint allows the authenticated user to view the sending schedules for campaigns | counts against monthly send bucket only when emails are sent |
| GET | /api/campaigns/{campaign_id}/sending-schedule | Show sending schedule for campaign, This endpoint allows the authenticated user to view the sending schedule of a single campaign | counts against monthly send bucket only when emails are sent |
| POST | /api/campaigns/{campaign_id}/create-schedule-from-template | Create campaign schedule from template, This endpoint allows the authenticated user to create the schedule of the campaign. | counts against monthly send bucket only when emails are sent |
| GET | /api/campaigns/{campaign_id}/sequence-steps | View campaign sequence steps (deprecated), This endpoint allows the authenticated user to view the sequence steps of the campaign. | counts against monthly send bucket only when emails are sent |
| POST | /api/campaigns/{campaign_id}/sequence-steps | Create sequence steps (deprecated), This endpoint allows the authenticated user to create the campaign sequence steps from scratch. | counts against monthly send bucket only when emails are sent |
| PUT | /api/campaigns/sequence-steps/{sequence_id} | Update sequence steps (deprecated), This endpoint allows the authenticated user to update the campaign sequence steps. | counts against monthly send bucket only when emails are sent |
| PATCH | /api/campaigns/sequence-steps/{sequence_step_id}/activate-or-deactivate | Activate or deactivate a sequence step variant, This endpoint allows the authenticated user to activate or deactivate a sequence step variant. You can get a list of sequence step IDs by making a request to `/campaigns/v1.1/{campaign_id}/sequence-s | counts against monthly send bucket only when emails are sent |
| DELETE | /api/campaigns/sequence-steps/{sequence_step_id} | Delete sequence step, This endpoint allows the authenticated user to delete a specific sequence step from a sequence | counts against monthly send bucket only when emails are sent |
| POST | /api/campaigns/sequence-steps/{sequence_step_id}/test-email | Send sequence step test email, This endpoint allows the authenticated user to send a test email from a sequence step. You need at least one lead in the campaign to send a test email. | counts against monthly send bucket only when emails are sent |
| GET | /api/campaigns/{campaign_id}/replies | Get campaign replies, This endpoint retrieves all replies associated with a campaign. This route supports cursor pagination for faster processing. We recommend using this for traversing larger datasets. More info here: ht | counts against monthly send bucket only when emails are sent |
| GET | /api/campaigns/{campaign_id}/leads | Get all leads for campaign, This route supports cursor pagination for faster processing. We recommend using this for traversing larger datasets. More info here: https://docs.emailbison.com/get-started/pagination#how-does-cursor | counts against monthly send bucket only when emails are sent |
| DELETE | /api/campaigns/{campaign_id}/leads | Remove leads from a campaign, This endpoint allows the authenticated user to remove leads from a campaign. **Hold on. You may not need to remove leads!** Please read carefully before attempting to delete. **I mapped the wrong cu | counts against monthly send bucket only when emails are sent |
| POST | /api/campaigns/{campaign_id}/leads/attach-lead-list | Import leads from existing list, This endpoint allows the authenticated user to import leads from an existing list into a campaign. | counts against monthly send bucket only when emails are sent |
| POSTasync | /api/campaigns/{campaign_id}/leads/attach-leads | Import leads by IDs, This endpoint allows the authenticated user to import leads by their IDs into a campaign. If you are adding leads to an active campaign, we cache them locally, and then sync every 5 minutes to ensure | free; leads added to an ACTIVE campaign are cached and synced every 5 minutes |
| POST | /api/campaigns/{campaign_id}/leads/stop-future-emails | Stop future emails for leads, This endpoint allows the authenticated user to stop future emails for selected leads in a campaign | counts against monthly send bucket only when emails are sent |
| GET | /api/campaigns/{campaign_id}/scheduled-emails | Get all scheduled emails for campaign, This endpoint retrieves all scheduled emails associated with a campaign. This route supports cursor pagination for faster processing. We recommend using this for traversing larger datasets. More info | counts against monthly send bucket only when emails are sent |
| GET | /api/campaigns/{campaign_id}/sender-emails | Get all campaign sender emails, This route supports cursor pagination for faster processing. We recommend using this for traversing larger datasets. More info here: https://docs.emailbison.com/get-started/pagination#how-does-cursor- | counts against monthly send bucket only when emails are sent |
| POST | /api/campaigns/{campaign_id}/stats | Get campaign stats (summary), This endpoint retrieves the statistics of all your campaigns. | counts against monthly send bucket only when emails are sent |
| POST | /api/campaigns/{campaign_id}/attach-sender-emails | Import sender emails by ID, This endpoint allows the authenticated user to attach sender emails to a campaign. | counts against monthly send bucket only when emails are sent |
| DELETE | /api/campaigns/{campaign_id}/remove-sender-emails | Remove sender emails by ID, This endpoint allows the authenticated user to remove sender emails from a draft or paused campaign. | counts against monthly send bucket only when emails are sent |
| POST | /api/campaigns/{campaign_id}/leads/move-to-another-campaign | Move leads to another campaign, This endpoint moves selected leads from a campaign to a selected target campaign. This process may take a few minutes if the campaigns are active. | counts against monthly send bucket only when emails are sent |
| GET | /api/campaigns/{campaign_id}/line-area-chart-stats | Get full normalized stats by date, This endpoint retrieves stats by date for a given period, for this campaign The user must provide a valid authentication token in the request header to access this endpoint. Events returned: `Replie | counts against monthly send bucket only when emails are sent |
| GET | /api/campaigns/{id} | Campaign details, This endpoint retrieves the details of a specific campaign. | counts against monthly send bucket only when emails are sent |
| DELETE | /api/campaigns/bulk | Bulk delete campaigns by ID, This endpoint allows the authenticated user to bulk delete campaigns. Campaign deletion is queued up and processed in the background. *Overall stats and lead conversations will not be affected** You | counts against monthly send bucket only when emails are sent |
| DELETE | /api/campaigns/{campaign_id} | Delete a campaign, This endpoint allows the authenticated user to delete a campaign. Campaign deletion is queued up and processed in the background. **Overall stats and lead conversations will not be affected** You wil | counts against monthly send bucket only when emails are sent |
| GET | /api/replies | Get all replies, This route supports cursor pagination for faster processing. We recommend using this for traversing larger datasets. More info here: https://docs.emailbison.com/get-started/pagination#how-does-cursor- | counts against monthly send bucket only when emails are sent |
| GET | /api/replies/{id} | Get reply, This endpoint retrieves a specific reply by its ID. The user must provide a valid authentication token in the request header to access this endpoint. | counts against monthly send bucket only when emails are sent |
| POST | /api/replies/new | Compose new email, This endpoint allows you to send a one-off email in a new email thread The user must provide a valid authentication token in the request header to access this endpoint. Please note that if you are s | counts against monthly send bucket only when emails are sent |
| POST | /api/replies/{reply_id}/reply | Create new reply, This endpoint allows you to reply to an existing email. The user must provide a valid authentication token in the request header to access this endpoint. Please note that if you are sending an array | counts against monthly send bucket only when emails are sent |
| POST | /api/replies/{reply_id}/forward | Forward reply, This endpoint allows you to forward an existing reply. The user must provide a valid authentication token in the request header to access this endpoint. Please note that if you are sending an array | counts against monthly send bucket only when emails are sent |
| PATCH | /api/replies/{reply_id}/mark-as-interested | Mark as interested, This endpoint marks a specific reply as interested. If a particular lead is already marked as "interested" within a campaign, no changes will be made. The user must provide a valid authentication tok | counts against monthly send bucket only when emails are sent |
| PATCH | /api/replies/{reply_id}/mark-as-not-interested | Mark as not interested, This endpoint marks a specific reply as not interested. The user must provide a valid authentication token in the request header to access this endpoint. | counts against monthly send bucket only when emails are sent |
| PATCH | /api/replies/{reply_id}/mark-as-read-or-unread | Mark as read or unread, This endpoint marks a specific reply as read or unread. The user must provide a valid authentication token in the request header to access this endpoint. | counts against monthly send bucket only when emails are sent |
| PATCH | /api/replies/{reply_id}/mark-as-automated-or-not-automated | Mark as automated or not automated, This endpoint marks a specific reply as automated or not automated. The user must provide a valid authentication token in the request header to access this endpoint. | counts against monthly send bucket only when emails are sent |
| PATCH | /api/replies/{reply_id}/unsubscribe | Unsubscribe contact that replied, This endpoint unsubscribes the contact associated with a specific reply from scheduled emails. The user must provide a valid authentication token in the request header to access this endpoint. | counts against monthly send bucket only when emails are sent |
| DELETE | /api/replies/{reply_id} | Delete reply, This endpoint deletes a specific reply by its ID. The user must provide a valid authentication token in the request header to access this endpoint. | counts against monthly send bucket only when emails are sent |
| GET | /api/replies/{reply_id}/conversation-thread | Get reply conversation thread, This endpoint gets you a reply object with all previous and newer messages to build out an email thread The user must provide a valid authentication token in the request header to access this endpoin | counts against monthly send bucket only when emails are sent |
| POST | /api/replies/{reply_id}/attach-scheduled-email-to-reply | Attach scheduled email to reply, This endpoint attaches a scheduled email to a reply (and lead). You can use this for untracked replies where headers may have been missing when the email was received. This will take care of increment | counts against monthly send bucket only when emails are sent |
| POST | /api/replies/{reply_id}/followup-campaign/push | Push reply (and lead) to "reply followup campaign", This endpoint lets you push a reply to a "reply followup campaign" The goal is to followup with interested leads in a templated, automated manner. Followups are done in the same conversation thread, a | counts against monthly send bucket only when emails are sent |
| GET | /api/sender-emails | List email accounts, Retrieves a collection of email accounts associated with the authenticated workspace. This route supports cursor pagination for faster processing. We recommend using this for traversing larger datase | counts against monthly send bucket only when emails are sent |
| GET | /api/sender-emails/{senderEmailId}/campaigns | Show Email Account Campaigns, Retrieves a collection of campaigns where this email account is being used | counts against monthly send bucket only when emails are sent |
| GET | /api/sender-emails/{senderEmailId} | Show email account details, Retrieves details of a specific email account. | counts against monthly send bucket only when emails are sent |
| PATCH | /api/sender-emails/{senderEmailId} | Update sender email, Update the settings for a specified sender email. | counts against monthly send bucket only when emails are sent |
| DELETE | /api/sender-emails/{senderEmailId} | Delete email account, Add multiple sender email addresses at once. | counts against monthly send bucket only when emails are sent |
| GET | /api/sender-emails/{senderEmailId}/replies | Get email account replies, This endpoint retrieves all replies associated with a given email account This route supports cursor pagination for faster processing. We recommend using this for traversing larger datasets. More inf | counts against monthly send bucket only when emails are sent |
| GET | /api/sender-emails/{senderEmailId}/oauth-access-token | Get email account oAuth access token, This endpoint retrieves the OAuth access token for a sender email account (Google or Microsoft accounts only). If a token has expired, a new one is automatically retrieved and returned using the save | counts against monthly send bucket only when emails are sent |
| PATCH | /api/sender-emails/signatures/bulk | Bulk update email signatures, Update the signatures of multiple sender emails at once. | counts against monthly send bucket only when emails are sent |
| PATCH | /api/sender-emails/daily-limits/bulk | Bulk update email daily limits, Update the daily sending limit of multiple sender emails at once. | counts against monthly send bucket only when emails are sent |
| POST | /api/sender-emails/imap-smtp | Create IMAP/SMTP Email Account, Creates a new IMAP/SMTP email account for the authenticated workspace. | counts against monthly send bucket only when emails are sent |
| POST | /api/sender-emails/bulk | Bulk add sender emails, Add multiple sender email addresses at once. | counts against monthly send bucket only when emails are sent |
| POST | /api/sender-emails/{senderEmailId}/check-mx-records | Check MX records, Checks the email host for a given email address and returns the host + all MX records. Results are not cached, and if a valid return is returned, the Sender Email account will be updated. | counts against monthly send bucket only when emails are sent |
| POST | /api/sender-emails/bulk-check-missing-mx-records | Bulk check missing MX records, This endpoint lets you trigger a job that will bulk check all email accounts with missing MX records in the given workspace. | counts against monthly send bucket only when emails are sent |
| POST | /api/sender-emails/{senderEmailId}/move-to-another-workspace | Move sender email to another workspace, This endpoint moves a sender email to a different workspace. Note: this endpoint requires a `super-admin` token that has access to the target workspace. | counts against monthly send bucket only when emails are sent |
| POST | /api/sender-emails/move-to-another-workspace-bulk | Move sender emails to another workspace (bulk), This endpoint bulk moves sender emails to a different workspace. Note: this endpoint requires a `super-admin` token that has access to the target workspace. | counts against monthly send bucket only when emails are sent |
| GET | /api/blacklisted-emails | Get all blacklisted emails, This route supports cursor pagination for faster processing. We recommend using this for traversing larger datasets. More info here: https://docs.emailbison.com/get-started/pagination#how-does-cursor- | counts against monthly send bucket only when emails are sent |
| POST | /api/blacklisted-emails | Create blacklisted email, Add a new email to the blacklist. | counts against monthly send bucket only when emails are sent |
| GET | /api/blacklisted-emails/{blacklisted_email_id} | Get blacklisted email, Get a single blacklisted email by email or ID. | counts against monthly send bucket only when emails are sent |
| DELETE | /api/blacklisted-emails/{blacklisted_email_id} | Remove blacklisted email, Remove an email from the blacklist. | counts against monthly send bucket only when emails are sent |
| POST | /api/blacklisted-emails/bulk | Bulk create blacklisted emails, Add multiple emails to the blacklist in a single request. | counts against monthly send bucket only when emails are sent |
| GET | /api/blacklisted-domains | Get all blacklisted domains, Retrieve a list of all blacklisted domains for the authenticated user. | counts against monthly send bucket only when emails are sent |
| POST | /api/blacklisted-domains | Create blacklisted domain, Add a new domain to the blacklist. | counts against monthly send bucket only when emails are sent |
| GET | /api/blacklisted-domains/{blacklisted_domain_id} | Get blacklisted domain, Get a single blacklisted domain by domain or ID. | counts against monthly send bucket only when emails are sent |
| DELETE | /api/blacklisted-domains/{blacklisted_domain_id} | Remove blacklisted domain, Remove a domain from the blacklist. | counts against monthly send bucket only when emails are sent |
| POST | /api/blacklisted-domains/bulk | Bulk create blacklisted domains, Add multiple domains to the blacklist in a single request. | counts against monthly send bucket only when emails are sent |
| GET | /api/tags | Get all tags for workspace, Retrieve a list of all tags for the authenticated user's workspace. | counts against monthly send bucket only when emails are sent |
| POST | /api/tags | Create tag, Add a new tag. | counts against monthly send bucket only when emails are sent |
| GET | /api/tags/{id} | View tag, View a saved tag. | counts against monthly send bucket only when emails are sent |
| DELETE | /api/tags/{tag_id} | Remove tag, Delete a tag. | counts against monthly send bucket only when emails are sent |
| POST | /api/tags/attach-to-campaigns | Attach tags to campaigns, Attach multiple tags to campaigns. | counts against monthly send bucket only when emails are sent |
| POST | /api/tags/remove-from-campaigns | Remove tags from campaigns, Detach multiple tags from campaigns. | counts against monthly send bucket only when emails are sent |
| POST | /api/tags/attach-to-leads | Attach tags to leads, Attach multiple tags to leads. | counts against monthly send bucket only when emails are sent |
| POST | /api/tags/remove-from-leads | Remove tags from leads, Detach multiple tags from leads. | counts against monthly send bucket only when emails are sent |
| POST | /api/tags/attach-to-sender-emails | Attach tags to email accounts, Attach multiple tags to email accounts | counts against monthly send bucket only when emails are sent |
| POST | /api/tags/remove-from-sender-emails | Remove tags from email accounts, Detach multiple tags from email accounts | counts against monthly send bucket only when emails are sent |
| GET | /api/custom-tracking-domain | Get all custom tracking domains, Retrieve a list of all custom tracking domains for the authenticated user. | counts against monthly send bucket only when emails are sent |
| POST | /api/custom-tracking-domain | Create custom tracking domain, Add a new custom tracking domain to the authenticated user's team. | counts against monthly send bucket only when emails are sent |
| GET | /api/custom-tracking-domain/{id} | Get a custom tracking domains, View a custom tracking domains. | counts against monthly send bucket only when emails are sent |
| DELETE | /api/custom-tracking-domain/{custom_tracking_domain_id} | Remove custom tracking domain, Delete a custom tracking domain. | counts against monthly send bucket only when emails are sent |
| GET | /api/campaign-events/stats | Breakdown of events by date, This endpoint retrieves stats by date for a given period, for this campaign Drill down into campaign event stats based on dates, campaign IDs, and/or sender email IDs The user must provide a valid a | counts against monthly send bucket only when emails are sent |
| GET | /api/campaigns/v1.1/{campaign_id}/sequence-steps | View campaign sequence steps (v1.1), This endpoint allows the authenticated user to view the sequence steps of the campaign. | counts against monthly send bucket only when emails are sent |
| POST | /api/campaigns/v1.1/{campaign_id}/sequence-steps | Create sequence steps (v1.1), This endpoint allows the authenticated user to create the campaign sequence steps from scratch. | counts against monthly send bucket only when emails are sent |
| PUT | /api/campaigns/v1.1/sequence-steps/{sequence_id} | Update sequence steps (v1.1), This endpoint allows the authenticated user to update the campaign sequence steps. | counts against monthly send bucket only when emails are sent |
| GET | /api/custom-variables | Get all custom variables, Retrieve a list of all custom variables for your workspace | counts against monthly send bucket only when emails are sent |
| POST | /api/custom-variables | Create a new custom variable, Add a new custom variable for your workspace | counts against monthly send bucket only when emails are sent |
| DELETE | /api/custom-variables/{custom_variable_id} | Remove custom variable, Delete a custom variable. | counts against monthly send bucket only when emails are sent |
| GET | /api/events | Get all events (up to 10 days), This route only supports cursor pagination due to large data sets. More info here: https://docs.emailbison.com/get-started/pagination#how-does-cursor-pagination-work This endpoint retrieves all event | counts against monthly send bucket only when emails are sent |
| GET | /api/events/{id} | Get event, This endpoint retrieves a specific event by its ID. The user must provide a valid authentication token in the request header to access this endpoint. | counts against monthly send bucket only when emails are sent |
| GET | /api/ignore-phrases | Get all ignore phrases, Retrieve a list of all ignore phrases for the authenticated user. | counts against monthly send bucket only when emails are sent |
| POST | /api/ignore-phrases | Create ignore phrase, Add a new ignore phrase | counts against monthly send bucket only when emails are sent |
| GET | /api/ignore-phrases/{ignore_phrase_id} | Get single ignore phrase, Retrieve the details of a specific ignore phrase | counts against monthly send bucket only when emails are sent |
| DELETE | /api/ignore-phrases/{ignore_phrase_id} | Remove ignore phrase, Remove an ignore phrase | counts against monthly send bucket only when emails are sent |
| GET | /api/lead-lists | Get all lead lists for workspace, Retrieve a paginated list of all lead lists for the authenticated user's workspace. | counts against monthly send bucket only when emails are sent |
| POST | /api/lead-lists | Create lead list, Add a new lead list. | counts against monthly send bucket only when emails are sent |
| GET | /api/lead-lists/{id} | View lead list, View a single lead list. | counts against monthly send bucket only when emails are sent |
| PUT | /api/lead-lists/{id} | Rename lead list, Update the name of an existing lead list. | counts against monthly send bucket only when emails are sent |
| GET | /api/leads | Get all leads, Retrieve a list of all leads for the authenticated user. This route supports cursor pagination for faster processing. We recommend using this for traversing larger datasets. More info here: https://d | counts against monthly send bucket only when emails are sent |
| POST | /api/leads | Create lead, Create a single lead (contact) record | counts against monthly send bucket only when emails are sent |
| GET | /api/leads/{lead_id} | Get single lead, Retrieve the details of a specific lead | counts against monthly send bucket only when emails are sent |
| PUT | /api/leads/{lead_id} | Update lead, Update the details of a specific lead Fields passed in the request will be updated. Fields and custom variables not passed will be cleared. | counts against monthly send bucket only when emails are sent |
| PATCH | /api/leads/{lead_id} | Update lead, Update the details of a specific lead Fields passed in the request will be updated. Fields and custom variables not passed will remain unchanged. | counts against monthly send bucket only when emails are sent |
| DELETE | /api/leads/{lead_id} | Delete a lead, Permanently delete a lead and its associated data **Hold on. You may not need to delete leads.** You may be able to simply re-upload leads instead **I mapped the wrong custom variables for these lea | counts against monthly send bucket only when emails are sent |
| GET | /api/leads/{lead_id}/replies | Get all replies for lead, This endpoint retrieves all replies for a specific lead The user must provide a valid authentication token in the request header to access this endpoint. This route supports cursor pagination for fa | counts against monthly send bucket only when emails are sent |
| POST | /api/leads/multiple | Bulk create leads, Create multiple lead records in a single request (limit 500 per request) Personal domains will be skipped unless enabled on your instance. get in touch with support if you want to send to personal do | free (unlimited lead storage); limit 500 leads per request; personal domains (gmail etc.) skipped unless enabled on instance |
| PATCH | /api/leads/bulk-update-status | Bulk update lead status, Bulk update the status of multiple selected leads | counts against monthly send bucket only when emails are sent |
| POST | /api/leads/create-or-update/multiple | Update or create multiple leads, Update or create multiple lead records in a single request (limit 500 per request). Personal domains will be skipped unless enabled on your instance. get in touch with support if you want to send to | free; limit 500 leads per request; personal domains skipped unless enabled |
| POST | /api/leads/create-or-update/{lead_id} | Update or create lead, Update the details of a specific lead if it exists, otherwise create a new record | counts against monthly send bucket only when emails are sent |
| PATCH | /api/leads/{lead_id}/unsubscribe | Unsubscribe lead, Unsubscribe a lead from scheduled emails. | counts against monthly send bucket only when emails are sent |
| POST | /api/leads/{lead_id}/blacklist | Add lead to blacklist, Add a lead to your global blacklist. | counts against monthly send bucket only when emails are sent |
| POST | /api/leads/bulk/csv | Bulk create leads using CSV, Create multiple leads in a single request using a CSV | counts against monthly send bucket only when emails are sent |
| GET | /api/leads/{lead_id}/scheduled-emails | Get all scheduled emails, Retrieves a collection of scheduled emails associated with a lead. These scheduled emails can have multiple statuses including: `scheduled`, `sending paused`, `stopped`, `bounced`, `unsubscribed`, `re | counts against monthly send bucket only when emails are sent |
| GET | /api/leads/{lead_id}/sent-emails | Get all sent emails for a lead, Retrieves a collection of **sent** campaign emails associated with a lead on the authenticated workspace. | counts against monthly send bucket only when emails are sent |
| PATCH | /api/leads/{lead_id}/update-status | Update lead status, Update the status of a lead | counts against monthly send bucket only when emails are sent |
| DELETE | /api/leads/bulk | Bulk delete leads by ID, Permanently delete leads and associated data **Hold on. You may not need to delete leads.** You may be able to simply re-upload leads instead **I mapped the wrong custom variables for these leads* | counts against monthly send bucket only when emails are sent |
| GET | /api/oauth-sessions/{id} | View oAuth Session, This endpoint allows the authenticated user to view an oAuth session. You can use this endpoint to check the status of the session. Possible statues are: pending, expired, success, failure. | counts against monthly send bucket only when emails are sent |
| POST | /api/oauth-sessions/microsoft | Create Microsoft oAuth Session, This endpoint creates a Microsoft oAuth session, valid for 10 minutes. Note: this endpoint has a limit of 60 requests per minute. | counts against monthly send bucket only when emails are sent |
| POST | /api/oauth-sessions/google | Create Google oAuth Session, This endpoint creates a Google oAuth session, valid for 10 minutes. Note: this endpoint has a limit of 60 requests per minute. | counts against monthly send bucket only when emails are sent |
| GET | /api/reply-templates | Get all reply templates, This endpoint retrieves all reply templates for the current workspace The user must provide a valid authentication token in the request header to access this endpoint | counts against monthly send bucket only when emails are sent |
| POST | /api/reply-templates | Create a reply template, This endpoint allows the authenticated user to create a new reply template | counts against monthly send bucket only when emails are sent |
| GET | /api/reply-templates/{id} | Reply template details | counts against monthly send bucket only when emails are sent |
| PUT | /api/reply-templates/{id} | Update a reply template, This endpoint allows the authenticated user to update an existing reply template. It will override the entire previous reply template, including attachments | counts against monthly send bucket only when emails are sent |
| DELETE | /api/reply-templates/{reply_template_id} | Delete reply template, This endpoint will permanently delete the specified reply template | counts against monthly send bucket only when emails are sent |
| GET | /api/scheduled-emails | Get all scheduled emails, This route supports cursor pagination for faster processing. We recommend using this for traversing larger datasets. More info here: https://docs.emailbison.com/get-started/pagination#how-does-cursor- | counts against monthly send bucket only when emails are sent |
| GET | /api/scheduled-emails/{id} | Get scheduled email, This endpoint retrieves a single scheduled (campaign) email. | counts against monthly send bucket only when emails are sent |
| GET | /api/warmup/sender-emails | List email accounts with warmup stats, This route supports cursor pagination for faster processing. We recommend using this for traversing larger datasets. More info here: https://docs.emailbison.com/get-started/pagination#how-does-cursor- | counts against monthly send bucket only when emails are sent |
| PATCH | /api/warmup/sender-emails/enable | Enable warmup for email accounts, This endpoint enables warmup for all the selected email accounts | counts against monthly send bucket only when emails are sent |
| PATCH | /api/warmup/sender-emails/disable | Disable warmup for email accounts, This endpoint disables warmup for all the selected email accounts | counts against monthly send bucket only when emails are sent |
| PATCH | /api/warmup/sender-emails/update-daily-warmup-limits | Update daily warmup limits for email accounts, This endpoint updates the daily warmup limits for selected email accounts | counts against monthly send bucket only when emails are sent |
| GET | /api/warmup/sender-emails/{senderEmailId} | Show single email account with warmup details, Retrieves a single email account (sender email) with its warmup details | counts against monthly send bucket only when emails are sent |
| GET | /api/webhook-attempts/{id} | Get webhook attempt, This endpoint retrieves a specific webhook attempt by its ID. The user must provide a valid authentication token in the request header to access this endpoint. | counts against monthly send bucket only when emails are sent |
| POST | /api/webhook-attempts/{webhook_attempt_id}/retry | Retry webhook attempt, This endpoint retries a specific webhook attempt by its ID. You can retry failed or successful attempts. The user must provide a valid authentication token in the request header to access this endpoi | counts against monthly send bucket only when emails are sent |
| GET | /api/webhook-deliveries/{id} | Get webhook delivery, This endpoint retrieves a specific webhook delivery by its ID. The user must provide a valid authentication token in the request header to access this endpoint. | counts against monthly send bucket only when emails are sent |
| GET | /api/webhook-events/sample-payload | Get sample webhook event payload | counts against monthly send bucket only when emails are sent |
| GET | /api/webhook-events/event-types | Get all webhook event types, Shows you a list of all valid webhook event types that are supported | counts against monthly send bucket only when emails are sent |
| POST | /api/webhook-events/test-event | Send a test webhook event, Send a test webhook for a chosen event type | counts against monthly send bucket only when emails are sent |
| GET | /api/webhook-url | Get all webhooks, Retrieve a list of all webhooks for the authenticated user's workspace. | counts against monthly send bucket only when emails are sent |
| POST | /api/webhook-url | Create a new webhook, Store a new webhook for the authenticated user's workspace. Provide an array of events to associate with the webhook; the events included in the array will be enabled. | counts against monthly send bucket only when emails are sent |
| GET | /api/webhook-url/{id} | Get a single webhook, Get the details of a specific webhook. | counts against monthly send bucket only when emails are sent |
| PUT | /api/webhook-url/{id} | Update a webhook, Modify an existing webhook's details. Send an array of events to modify the webhook; the events included will be enabled, and those not included will be disabled. | counts against monthly send bucket only when emails are sent |
| DELETE | /api/webhook-url/{webhook_url_id} | Delete a webhook, Remove a webhook url by its ID. | counts against monthly send bucket only when emails are sent |
| GET | /api/workspaces | List Workspaces, This endpoint retrieves all of the authenticated user's workspaces. The user must provide a valid authentication token in the request header to access this endpoint. | counts against monthly send bucket only when emails are sent |
| POST | /api/workspaces | Create Workspace, This endpoint allows the authenticated user to create a new workspace. The user must provide a valid authentication token in the request header and the details of the new workspace in the request bod | counts against monthly send bucket only when emails are sent |
| POST | /api/workspaces/switch-workspace | Switch Workspace, This endpoint allows the authenticated user to switch to a different workspace. The user must provide a valid authentication token in the request header and the ID of the target workspace in the requ | counts against monthly send bucket only when emails are sent |
| PUT | /api/workspaces/{team_id} | Update Workspace, This endpoint allows the authenticated user to update their workspace information, specifically the workspace name. The user must provide a valid authentication token in the request header and the ID | counts against monthly send bucket only when emails are sent |
| GET | /api/workspaces/{team_id} | Workspace Details, This endpoint retrieves the details of the authenticated user's workspace. The user must provide a valid authentication token in the request header to access this endpoint. | counts against monthly send bucket only when emails are sent |
| POST | /api/workspaces/invite-members | Invite Team Member, This endpoint allows the authenticated user to invite a new member to their team. The user must provide a valid authentication token in the request header and the email and role of the new team membe | counts against monthly send bucket only when emails are sent |
| POST | /api/workspaces/accept/{team_invitation_id} | Accept Workspace Invitation, This endpoint allows the user to accept an invitation to join a workspace. The user must provide a valid authentication token in the request header and the ID of the workspace invitation. | counts against monthly send bucket only when emails are sent |
| PUT | /api/workspaces/members/{user_id} | Update Workspace Member, This endpoint allows the authenticated user to update the role of a workspace member. The user must provide a valid authentication token in the request header and the ID of the workspace member and t | counts against monthly send bucket only when emails are sent |
| DELETE | /api/workspaces/members/{user_id} | Delete Workspace Member, This endpoint allows the authenticated user to remove a workspace member. The user must provide a valid authentication token in the request header and the ID of the workspace member. | counts against monthly send bucket only when emails are sent |
| GET | /api/workspaces/v1.1 | List Workspaces, This endpoint retrieves all of the authenticated user's workspaces. The user must provide a valid authentication token in the request header to access this endpoint. | counts against monthly send bucket only when emails are sent |
| POST | /api/workspaces/v1.1 | Create Workspace, This endpoint allows the authenticated user to create a new workspace. The user must provide a valid authentication token in the request header and the details of the new workspace in the request bod | counts against monthly send bucket only when emails are sent |
| POST | /api/workspaces/v1.1/users | Create User (and add to workspace), This endpoint provides a convenient way to create a new user on your instance, and add them to the current workspace. This provides an alternate flow where you want to mass create users. If you simpl | counts against monthly send bucket only when emails are sent |
| POST | /api/workspaces/v1.1/{team_id}/api-tokens | Create API token for workspace, This endpoint lets you create an API token for a given workspace Requires a "super admin" API token | counts against monthly send bucket only when emails are sent |
| POST | /api/workspaces/v1.1/switch-workspace | Switch Workspace, This endpoint allows the authenticated user to switch to a different workspace. The user must provide a valid authentication token in the request header and the ID of the target workspace in the requ | counts against monthly send bucket only when emails are sent |
| DELETE | /api/workspaces/v1.1/{team_id} | Delete Workspace, This endpoint allows the authenticated user to delete a workspace. The user must provide a valid super-admin authentication token in the request header and the ID of the target workspace in the query | counts against monthly send bucket only when emails are sent |
| PUT | /api/workspaces/v1.1/{team_id} | Update Workspace, This endpoint allows the authenticated user to update their workspace information, specifically the workspace name. The user must provide a valid authentication token in the request header and the ID | counts against monthly send bucket only when emails are sent |
| GET | /api/workspaces/v1.1/{team_id} | Workspace Details, This endpoint retrieves the details of the authenticated user's workspace. The user must provide a valid authentication token in the request header to access this endpoint. | counts against monthly send bucket only when emails are sent |
| POST | /api/workspaces/v1.1/invite-members | Invite Team Member, This endpoint allows the authenticated user to invite a new member to their team. The user must provide a valid authentication token in the request header and the email and role of the new team membe | counts against monthly send bucket only when emails are sent |
| POST | /api/workspaces/v1.1/accept/{team_invitation_id} | Accept Workspace Invitation, This endpoint allows the user to accept an invitation to join a workspace. The user must provide a valid authentication token in the request header and the ID of the workspace invitation. | counts against monthly send bucket only when emails are sent |
| PUT | /api/workspaces/v1.1/members/{user_id} | Update Workspace Member Role, This endpoint allows the authenticated user to update the role of a workspace member. The user must provide a valid authentication token in the request header and the ID of the workspace member and t | counts against monthly send bucket only when emails are sent |
| DELETE | /api/workspaces/v1.1/members/{user_id} | Delete Workspace Member, This endpoint allows the authenticated user to remove a workspace member. This does not delete the user account. It only removes them from the workspace. The user must provide a valid authentication | counts against monthly send bucket only when emails are sent |
| GET | /api/workspaces/v1.1/master-inbox-settings | Get Master Inbox Settings, This endpoint retrieves the master inbox settings for this workspace. The user must provide a valid authentication token in the request header to access this endpoint. | counts against monthly send bucket only when emails are sent |
| PATCH | /api/workspaces/v1.1/master-inbox-settings | Update Master Inbox Settings, This endpoint updates the master inbox settings for this workspace. The user must provide a valid authentication token in the request header to access this endpoint. | counts against monthly send bucket only when emails are sent |
| GET | /api/workspaces/v1.1/stats | Get workspace stats (summary), This endpoint retrieves overall stats for this workspace between two given dates. The user must provide a valid authentication token in the request header to access this endpoint. | counts against monthly send bucket only when emails are sent |
| GET | /api/workspaces/v1.1/line-area-chart-stats | Get full normalized stats by date, This endpoint retrieves stats by date for a given period The user must provide a valid authentication token in the request header to access this endpoint. Events returned: `Replied`, `Total Opens` | counts against monthly send bucket only when emails are sent |
No endpoint matches that filter.
