// connections

EmailBison

Let agents run cold email on your own EmailBison instance through superagnt_: campaigns, sequences, leads, the master inbox, mailboxes and warmup, stats and webhooks. Connects with an EmailBison API token.

38 mcp tools134 operationsvendor sync
rest
https://api.superagnt.com/v1/connections/emailbison plus the vendor's own path, with your superagnt_ API key as Authorization: Bearer.
mcp
Tools named connection_emailbison_* on https://mcp.superagnt.com/mcp, served once the account is connected.
billing
EmailBison bills your own account. Calls cost no superagnt_ data credits.
rate limit
3 requests a second, 180 a minute: the vendor's ceiling as the registry records it, for sizing bursts. Your plan's own limit is on Connections.
sync
Can copy 7 tables into your workspace database and keep them fresh: the tables.

The EmailBison connection lets agents run cold email on the EmailBison instance your team already sends from. Agents build campaigns with sequences and schedules, create leads and enroll them, work the master inbox (read threads, reply, forward, mark interested), and keep sender mailboxes and their warmup healthy. They also manage tags, lead lists, custom variables and the blacklist, read stats and the 10-day event log, and register webhooks.

one workspace per connection

Every EmailBison call acts in exactly one EmailBison workspace, the one the token points at: get_account shows which. list_workspaces lists every workspace the token's user belongs to, but listing does not switch. A superagnt_ workspace holds one EmailBison connection.

01

Setup

  1. Create an api-user token. In EmailBison open Settings → Developer API → New API Token and create an api-user token inside the workspace your agents should work in. It only ever reaches that workspace.
  2. Connect EmailBison. In the superagnt app open Integrations, pick EmailBison, enter the address you log in at under EmailBison address, paste the token under API token and press Connect.

A super-admin token acts as the user who created it and follows whichever workspace that user switches to, so what agents read and change can move without warning. Use one only if agents must delete a workspace or move mailboxes to another workspace, which need it.

The instance address

There is no shared EmailBison API host: every customer runs a white-labeled instance on its own domain. Enter the address you log in at, for example https://send.youragency.com. superagnt_ adds /api and sends every call there.

  • A bare host gets https:// added. After the host only / or /api is accepted: any other path is refused, so enter only the address you log in at.
  • The address must use https:// and the default port, with no login details, query or fragment, and it must resolve to a public address. It is checked when you save and again before every call.
  • Before anything is stored, superagnt_ sends the token to that address with a GET /users read, which has 15 seconds to answer. A refused token is a 400 VENDOR_CREDENTIAL_REJECTED; an address that does not answer, or answers with a redirect, is a 400 asking you to check the address.
  • To change the address, open Integrations, pick EmailBison, enter the new address and paste the token again before Save Changes: an address change without the token is refused. A new token on its own is checked against the stored address.

02

Things to know

  • Some failed actions, such as creating a workspace or a campaign and sending an email, answer HTTP 200 with success: false in the body. Read the body before reporting success.
  • EmailBison publishes no numeric rate limit: the ceiling above is for sizing bursts. When it answers 429, the call comes back as RATE_LIMITED (HTTP 429): back off, then retry.
  • update_campaign_settings treats every boolean you leave out as false, so send each tracking and unsubscribe flag you want kept on.
  • upsert_leads replaces every field and custom variable of an existing lead by default, clearing what you do not send. Pass existing_lead_behavior: "patch" to update only what you send.
  • The connection's tools and operations do not cover account profile or password changes, API-token minting, mailbox OAuth tokens or OAuth connection sessions, creating users or IMAP/SMTP mailboxes (they take passwords), switching the token's workspace, CSV uploads, or test sends.

Pagination and history

  • Paged lists return 15 rows a page, and page numbers stop at 1,000 pages. Walk a large list in cursor mode: pass pagination_type=cursor, then send each response's meta.next_cursor back as cursor.
  • Events are kept for 10 days. list_events returns everything that fires a webhook, with the webhook's payload, and pages by cursor only.
  • Replies have no date filter. Page through list_replies in cursor mode, or use the event log or a webhook for new replies.
  • Lead date filters are day-granular: created_at_value and updated_at_value (over REST, filters[created_at][value] and filters[updated_at][value]) take a date, YYYY-MM-DD.

03

Permissions

Each operation starts with a default level. A deployed agent pauses for a person's approval before an Ask or Always ask operation and runs an Act operation straight away. A person can change any level per tool, for one agent or for the whole workspace: see Permissions.

  • Always ask: sending a reply, a forward or a one-off email; pushing a reply into a follow-up campaign; resuming (launching), pausing or archiving a campaign; enrolling leads or a lead list in a campaign, moving leads to another campaign, and stopping or removing a campaign's leads; removing mailboxes from a campaign; removing a workspace member; taking an address or domain off the blacklist; and every delete (workspaces, campaigns, sequence steps, replies, leads, custom variables, tags, sender emails and webhooks).
  • Ask: inviting a workspace member or changing a member's role, unsubscribing a lead or the contact behind a reply, moving mailboxes to another workspace, and creating or changing a webhook.
  • Act: every other operation, including every read and building a campaign before it sends (creating it, its settings, schedule, sequence and mailboxes). Setting a lead's status to unsubscribed and blacklisting also stop emails, yet run without asking: set them to Ask if an agent should check first.

04

Examples

Check which workspace the token acts in

the token's user and workspacebash
curl "https://api.superagnt.com/v1/connections/emailbison/users" \
  -H "Authorization: Bearer $AGNTDATA_API_KEY"

List active campaigns in cursor mode

active campaignsbash
curl "https://api.superagnt.com/v1/connections/emailbison/campaigns?status=active&pagination_type=cursor" \
  -H "Authorization: Bearer $AGNTDATA_API_KEY"

Read unread replies in the master inbox

unread inbox repliesbash
curl "https://api.superagnt.com/v1/connections/emailbison/replies?folder=inbox&read=0&pagination_type=cursor" \
  -H "Authorization: Bearer $AGNTDATA_API_KEY"

Create or update leads

upsert leads, updating only what is sentbash
curl -X POST "https://api.superagnt.com/v1/connections/emailbison/leads/create-or-update/multiple" \
  -H "Authorization: Bearer $AGNTDATA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "existing_lead_behavior": "patch",
    "leads": [
      { "first_name": "Ada", "last_name": "Lovelace", "email": "ada@example.com", "company": "Analytical Engines" }
    ]
  }'

A created lead is in no campaign. Enroll leads by id with add_leads_to_campaign (lead_ids). On a deployed agent it defaults to Always ask, because leads in an active campaign start receiving emails (EmailBison picks up added leads about every 5 minutes).

05

Receiving EmailBison webhooks

create_webhook registers a URL for the events you pick, out of 23 (lead_replied, lead_interested, email_bounced, lead_unsubscribed and more): list_webhook_event_types lists them and get_webhook_sample_payload shows an event's payload. Point it at a superagnt_ inbound webhook endpoint to trigger an agent.

  • EmailBison retries a failed delivery up to five times over 24 hours.
  • Deliveries are kept 10 days: get_webhook_delivery reads one with its attempts, get_webhook_attempt one attempt with its response, and retry_webhook_attempt sends an attempt again.
  • update_webhook replaces the name, URL and events: events left out are switched off.

06

Sync

An EmailBison sync copies the EmailBison workspace your token acts in into your workspace database. Turn it on from the Sync panel on the EmailBison connection page in the superagnt app; the panel previews the rows and webhook events against your plan before anything starts. agnt_sync_catalog describes every table and column. How syncs work in general: Vendor sync.

How updates arrive. The sync registers one webhook in your EmailBison workspace, named superagnt_ sync, for replies, interested marks, unsubscribes, bounces and untracked replies. A delivery makes the sync re-read the reply, lead or sent email it names and read the event log. If EmailBison refuses the webhook, the sync checks EmailBison on its regular schedule instead. Sends, opens and first contacts are polled by default, so they show in the campaign counters; they reach emailbison_events only once you switch them to webhooks in Customize. EmailBison keeps only 10 days of events, so the first backfill of emailbison_events covers at most 10 days, and the hourly read of the event log picks up the events a missed webhook skipped.

Scope.

  • An EmailBison token reads exactly one EmailBison workspace, so the sync's workspace filter offers only that one. To sync another EmailBison workspace, connect its token in a superagnt_ workspace of its own.
  • The sync records the workspace it started on and rechecks it every hour. If a super-admin token's user switches workspace in EmailBison, the sync stops with "The EmailBison connection now answers as a different account." instead of going on reading another client.
  • Switching back does not restart it: turn the sync off and on again to start fresh, and delete the tables too to remove the old workspace's rows. An api-user token never drifts.
07// sync tables

What a EmailBison sync copies

A sync copies these tables into your workspace database and keeps them fresh, so an agent reads local rows instead of calling EmailBison on every run. Turn tables on and off from the Sync panel on the connection. Every table also carries _raw, _hash, _synced_at and _deleted_at. How syncs work: Vendor sync.

beta

The EmailBison sync is built from EmailBison's API documentation and has not been verified against a live EmailBison account yet. A field the documentation does not show stays in each row's _raw column.
TableWhat it holdsDefault
emailbison_campaigns

Campaigns

Every campaign with its status and lifetime counters, re-read every hour. Once a day the pass also re-reads each campaign's email steps.on
emailbison_sequence_steps

Email steps

The email steps of each synced campaign, with subjects, waits and A/B variants, re-read daily. A step removed from its campaign is marked deleted.on
emailbison_leads

Leads

Every lead in the workspace with its verification status, read by EmailBison's daily change filter and kept current by reply and unsubscribe webhooks.on
emailbison_replies

Replies

Inbox replies in the history window with their text, kept current by reply webhooks, a frequent read of the newest replies and a daily full read.on
emailbison_events

Events

EmailBison's event log for the event types switched to webhook (replies, interest, unsubscribes, bounces and untracked replies by default). EmailBison keeps 10 days, so the backfill covers 10 days. Kept for 90 days by default.on
emailbison_sender_emails

Mailboxes

The sending mailboxes with their status, daily limit and lifetime counters, re-read every hour.on
emailbison_sent_emails

Sent emails

One row per campaign email sent, with opens, clicks and replies; the last 2 days are re-read daily as counts move. Off by default: high-volume senders pass row caps fast. Kept for 90 days by default.off
08// mcp tools

38 tools, one per resource and risk

MCP servers and agents on the grouped surface list EmailBison as these tools. Each takes an action, and the ones that work across record types an object. Every operation also keeps its own per-operation name, in the next table, which works on every server. How grouping works: Grouped tools.

ToolRiskActions
connection_emailbison_workspaces_read

Read EmailBison workspaces

Read the token's user and the one workspace every call acts in, list the workspaces (clients) the user belongs to, get one, or read the current workspace's master inbox settings. Listing does not switch workspace: an api-user token stays in the workspace it was created in, and a super-admin token follows its user's current workspace in the EmailBison app.

read
currentlistgetinbox_settings
connection_emailbison_workspaces_write

Create and change EmailBison workspaces

Create a workspace (the token's user owns it, and this connection keeps acting in its current one), rename one, change the current workspace's master inbox settings, or invite someone to it by email and change a member's role. An invitee gets the workspace's campaigns and inbox once they accept. create can answer HTTP 200 with success: false, so check the body before reporting success.

write
createrenameupdate_inbox_settingsinvite_memberset_member_role
connection_emailbison_workspaces_delete

Delete an EmailBison workspace or remove a member

Permanently delete a workspace and everything in it (campaigns, leads, mailboxes, replies), which needs a super-admin token and cannot be undone, or remove a member from the current workspace: they lose access at once, and their EmailBison user account stays.

destructive
deleteremove_member
connection_emailbison_stats_read

Read EmailBison stats

Read sent, opens, unique opens, replies, bounces, unsubscribes and interested counts between two dates (YYYY-MM-DD), as totals or per day, for the current workspace or one campaign, or per-day event counts narrowed to campaigns and sender emails. These counts have no clicks.

read
workspaceworkspace_dailycampaigncampaign_dailyevents_daily
connection_emailbison_campaigns_read

Read EmailBison campaigns

List campaigns with their counters (15 per page; pagination_type cursor walks large sets), get one with its settings, read its sequence steps, or list the sender emails it sends from. Leads: connection_emailbison_campaign_leads_read; schedule: connection_emailbison_schedules_read.

read
listgetsequence_stepssender_emails
connection_emailbison_campaigns_write

Create and run EmailBison campaigns

Create a draft campaign, change its settings, copy it, add the mailboxes it sends from, and resume (launch) or pause it. A resumed campaign emails its leads on its schedule; it needs leads, sender emails, a sequence and a schedule first. update treats every boolean it is not sent as false, so send each tracking and unsubscribe flag you want kept on. create can answer HTTP 200 with success: false, so check the body. Sequence: connection_emailbison_sequences_write; schedule: connection_emailbison_schedules_write; leads: connection_emailbison_campaign_leads_write.

write
createupdateduplicateadd_sender_emailsresumepause
connection_emailbison_campaigns_delete

Delete or archive EmailBison campaigns

Permanently delete one or several campaigns (queued; their overall stats and lead conversations are kept, but the campaigns cannot be recovered), archive a campaign so it stops sending and leaves the active list, or remove mailboxes from a draft or paused campaign.

destructive
deletedelete_bulkarchiveremove_sender_emails
connection_emailbison_schedules_read

Read EmailBison sending schedules

Read the days, hours and timezone a campaign sends in, the saved schedule templates and the timezone ids a schedule accepts, or how many emails every campaign or one campaign is set to send today, tomorrow or the day after.

read
gettemplatestimezonessending_plancampaign_sending_plan
connection_emailbison_schedules_write

Set an EmailBison campaign's schedule

Set the days, hours (HH:MM, 24h) and timezone a campaign sends in, replace that schedule, or apply a saved template; connection_emailbison_schedules_read lists the templates and timezone ids. save_as_template also saves the schedule as a reusable template.

write
createupdatefrom_template
connection_emailbison_sequences_write

Write an EmailBison campaign's sequence

Create a campaign's sequence of email steps from scratch, update existing steps (each by its id, from connection_emailbison_campaigns_read action sequence_steps), or turn one A/B variant of a step on or off. Attachments are not supported.

write
createupdateset_variant_active
connection_emailbison_sequences_delete

Delete an EmailBison sequence step

Delete one step from a campaign's sequence. It cannot be undone.

destructive
delete_step
connection_emailbison_campaign_leads_read

Read an EmailBison campaign's leads

Page through the leads enrolled in a campaign with their per-campaign status and counters, filtered by search, campaign status, sent, open and reply counts, verification status, tags, or created and updated dates (day-granular). 15 per page; pagination_type cursor walks large sets.

read
list
connection_emailbison_campaign_leads_write

Enroll leads in EmailBison campaigns

Enroll existing leads (by id) or every lead of a lead list in a campaign, or move leads from one campaign into another, where they keep receiving emails. In an active campaign enrolled leads start receiving emails (EmailBison syncs added leads about every 5 minutes). allow_parallel_sending also enrolls leads already in sequence in another campaign. To follow up a reply in its own thread: connection_emailbison_replies_write action follow_up.

write
addadd_listmove
connection_emailbison_campaign_leads_delete

Stop or remove leads in an EmailBison campaign

Stop every future email of a campaign to some leads, keeping their history, or remove them from the campaign, which also resets their history in it and cannot be undone. To just stop emailing them, prefer stop.

destructive
stopremove
connection_emailbison_replies_read

Read the EmailBison master inbox

Page through the master inbox (folder also reaches sent manual emails, spam and bounces; untracked replies included) with full bodies, headers and attachment links, filtered by search, status, read state, tags, campaign, sender email or lead; get one reply, or its whole thread. There is no date filter: page with pagination_type cursor.

read
listgetthreadby_campaignby_leadby_sender_email
connection_emailbison_replies_write

Triage EmailBison replies

Mark a reply interested (its lead in the campaign too) or not interested, read or unread, or automated (out of office and the like) or not; unsubscribe the contact who replied from every scheduled email; or put the reply's lead into a reply_followup campaign, which sends templated follow-ups in the same thread from its last message (the reply's sender email must still exist). skip_webhooks: true fires no EmailBison webhook. Sending: connection_emailbison_replies_send.

write
mark_interestedmark_not_interestedmark_readmark_automatedunsubscribefollow_up
connection_emailbison_replies_send

Send EmailBison emails

Reply in the thread of a reply, forward a reply to new recipients, or send a one-off email in a new thread from one of the workspace's mailboxes. Each goes out to real people at once, so get the user's sign-off first; on a deployed agent a send asks for approval by default. EmailBison can answer HTTP 200 with success: false, so check the body before reporting success.

write
replyforwardsend_new
connection_emailbison_replies_delete

Delete an EmailBison reply

Delete a reply from the master inbox. It cannot be undone.

destructive
delete
connection_emailbison_leads_read

Read EmailBison leads

Page through the workspace's leads (contacts) with their custom variables, per-campaign data and overall stats, filtered by search, campaign status, sent, open and reply counts, verification status, tags, or created and updated dates (day-granular); get one; or list the custom lead variables sequences use as {VARIABLE}. 15 per page; pagination_type cursor walks large sets.

read
listgetcustom_variables
connection_emailbison_leads_write

Add and update EmailBison leads

Create one lead or up to 500, create or update up to 500 by email, update a lead, set the verification status of one or several leads (unsubscribed stops every email to them), unsubscribe a lead from every scheduled email, or define a custom lead variable (a lead can only carry variables that exist). upsert_bulk replaces every field and custom variable it is not sent unless existing_lead_behavior is patch. A created lead is in no campaign: enroll it with connection_emailbison_campaign_leads_write.

write
createcreate_bulkupsert_bulkupdateset_statusset_status_bulkunsubscribecreate_custom_variable
connection_emailbison_leads_delete

Delete EmailBison leads

Permanently delete a lead or several with their history (campaign data, conversations, stats), or delete a custom variable with its values on every lead. None of it can be undone; to stop emailing a lead, unsubscribe it with connection_emailbison_leads_write instead.

destructive
deletedelete_bulkdelete_custom_variable
connection_emailbison_lead_lists_read

Read EmailBison lead lists

List the workspace's lead lists (15 per page) or get one. Enroll a list's leads in a campaign with connection_emailbison_campaign_leads_write action add_list.

read
listget
connection_emailbison_lead_lists_write

Create and rename EmailBison lead lists

Create an empty lead list, or rename one.

write
createrename
connection_emailbison_tags_read

Read EmailBison tags

List the workspace's tags, which go on campaigns, leads and sender emails, or get one.

read
listget
connection_emailbison_tags_write

Create and apply EmailBison tags

Create a tag, or attach tags to and detach them from campaigns, leads or sender emails. Attaching fires a tag_attached webhook per tag unless skip_webhooks is true.

write
createtag_campaignsuntag_campaignstag_leadsuntag_leadstag_sender_emailsuntag_sender_emails
connection_emailbison_tags_delete

Delete an EmailBison tag

Delete a tag and remove it everywhere it is attached. It cannot be undone.

destructive
delete
connection_emailbison_scheduled_emails_read

Read EmailBison campaign emails

Page through the campaign emails scheduled or sent across the workspace, with status, sent_at, opens, clicks, replies and the step each belongs to, filtered by status, campaigns, leads, sender emails or scheduled date; get one; or list one campaign's emails, the emails scheduled for one lead, or those already sent to it.

read
listgetby_campaignby_leadsent_to_lead
connection_emailbison_sender_emails_read

Read EmailBison sender emails

Page through the workspace's sending mailboxes with their connection status and lifetime counters, filtered by search, status, tags or cached warmup score; get one with its settings; or list the campaigns that send from one. SMTP and IMAP passwords are never returned. Warmup stats: connection_emailbison_warmup_read.

read
listgetcampaigns
connection_emailbison_sender_emails_write

Manage EmailBison sender emails

Change a mailbox's display name, daily sending limit or signature, set one signature or daily limit on several mailboxes, recheck MX records (one mailbox now, or a background job for every mailbox missing them), or move mailboxes to another workspace, which takes them out of this workspace's campaigns and needs a super-admin token with access to the target.

write
updateset_signaturesset_daily_limitscheck_mxrecheck_missing_mxmovemove_bulk
connection_emailbison_sender_emails_delete

Delete an EmailBison sender email

Remove a mailbox from the workspace; campaigns stop sending from it. It cannot be undone.

destructive
delete
connection_emailbison_warmup_read

Read EmailBison warmup stats

Read mailbox warmup stats between two dates (YYYY-MM-DD): warmup emails sent, replies, saved from spam, score and bounces, for every mailbox (filtered by search, tags, warmup state or MX record state) or for one.

read
listget
connection_emailbison_warmup_write

Manage EmailBison warmup

Turn warmup on or off for mailboxes, or set how many warmup emails (and optionally warmup replies) they send per day. EmailBison advises changing daily_reply_limit only on your inbox reseller's instruction.

write
enabledisableset_daily_limits
connection_emailbison_blacklist_read

Read the EmailBison blacklist

List or search the blacklisted email addresses or domains, which no campaign emails, or get one entry by the address or domain itself or by its entry id.

read
list_emailsget_emaillist_domainsget_domain
connection_emailbison_blacklist_write

Blacklist EmailBison emails and domains

Add an email address, a domain, or a lead's email to the workspace blacklist so no campaign emails it. Taking an entry off: connection_emailbison_blacklist_delete.

write
add_emailadd_domainadd_lead
connection_emailbison_blacklist_delete

Remove from the EmailBison blacklist

Take an email address or domain off the blacklist, by the address or domain itself or by its entry id, so campaigns can email it again.

destructive
remove_emailremove_domain
connection_emailbison_webhooks_read

Read EmailBison webhooks and events

List the webhook URLs and the events each receives, get one, list the event types or get a sample payload, get a delivery (kept 10 days) or one of its attempts, or read the event log: everything that fires a webhook, with the webhook payload, kept 10 days and paged by cursor only.

read
listgetevent_typessample_payloaddeliveryattempteventsevent
connection_emailbison_webhooks_write

Create and change EmailBison webhooks

Register a URL that receives the chosen events (EmailBison then sends lead and email data to it, retried up to five times over 24 hours), replace a webhook's name, URL and events (events left out are switched off), or send a delivery attempt again.

write
createupdateretry_attempt
connection_emailbison_webhooks_delete

Delete an EmailBison webhook

Stop and remove a webhook URL. It cannot be undone.

destructive
delete
09// operations

All 134 operations

Each operation is a REST path under https://api.superagnt.com/v1/connections/emailbison and an MCP tool. The per-operation tool name is the one permissions, approvals and usage records use.

OperationMCP tool
GET/users

Get the token's user and workspace

connection_emailbison_get_accountgrouped: connection_emailbison_workspaces_read, action current
GET/workspaces/v1.1

List workspaces

connection_emailbison_list_workspacesgrouped: connection_emailbison_workspaces_read, action list
POST/workspaces/v1.1

Create a workspace

connection_emailbison_create_workspacegrouped: connection_emailbison_workspaces_write, action create
GET/workspaces/v1.1/{workspace_id}

Get a workspace

connection_emailbison_get_workspacegrouped: connection_emailbison_workspaces_read, action get
PUT/workspaces/v1.1/{workspace_id}

Rename a workspace

connection_emailbison_rename_workspacegrouped: connection_emailbison_workspaces_write, action rename
DELETE/workspaces/v1.1/{workspace_id}

Delete a workspace

connection_emailbison_delete_workspacegrouped: connection_emailbison_workspaces_delete, action delete
POST/workspaces/v1.1/invite-members

Invite a member

connection_emailbison_invite_workspace_membergrouped: connection_emailbison_workspaces_write, action invite_member
PUT/workspaces/v1.1/members/{user_id}

Change a member's role

connection_emailbison_update_workspace_member_rolegrouped: connection_emailbison_workspaces_write, action set_member_role
DELETE/workspaces/v1.1/members/{user_id}

Remove a member

connection_emailbison_remove_workspace_membergrouped: connection_emailbison_workspaces_delete, action remove_member
GET/workspaces/v1.1/master-inbox-settings

Get master inbox settings

connection_emailbison_get_master_inbox_settingsgrouped: connection_emailbison_workspaces_read, action inbox_settings
PATCH/workspaces/v1.1/master-inbox-settings

Update master inbox settings

connection_emailbison_update_master_inbox_settingsgrouped: connection_emailbison_workspaces_write, action update_inbox_settings
GET/workspaces/v1.1/stats

Workspace stats summary

connection_emailbison_get_workspace_statsgrouped: connection_emailbison_stats_read, action workspace
GET/workspaces/v1.1/line-area-chart-stats

Workspace stats by day

connection_emailbison_get_workspace_daily_statsgrouped: connection_emailbison_stats_read, action workspace_daily
GET/campaigns

List campaigns

connection_emailbison_list_campaignsgrouped: connection_emailbison_campaigns_read, action list
POST/campaigns

Create a campaign

connection_emailbison_create_campaigngrouped: connection_emailbison_campaigns_write, action create
GET/campaigns/{campaign_id}

Get a campaign

connection_emailbison_get_campaigngrouped: connection_emailbison_campaigns_read, action get
DELETE/campaigns/{campaign_id}

Delete a campaign

connection_emailbison_delete_campaigngrouped: connection_emailbison_campaigns_delete, action delete
PATCH/campaigns/{campaign_id}/update

Update campaign settings

connection_emailbison_update_campaign_settingsgrouped: connection_emailbison_campaigns_write, action update
POST/campaigns/{campaign_id}/duplicate

Duplicate a campaign

connection_emailbison_duplicate_campaigngrouped: connection_emailbison_campaigns_write, action duplicate
PATCH/campaigns/{campaign_id}/pause

Pause a campaign

connection_emailbison_pause_campaigngrouped: connection_emailbison_campaigns_write, action pause
PATCH/campaigns/{campaign_id}/resume

Resume (launch) a campaign

connection_emailbison_resume_campaigngrouped: connection_emailbison_campaigns_write, action resume
PATCH/campaigns/{campaign_id}/archive

Archive a campaign

connection_emailbison_archive_campaigngrouped: connection_emailbison_campaigns_delete, action archive
DELETE/campaigns/bulk

Delete several campaigns

connection_emailbison_bulk_delete_campaignsgrouped: connection_emailbison_campaigns_delete, action delete_bulk
POST/campaigns/{campaign_id}/stats

Campaign stats summary

connection_emailbison_get_campaign_statsgrouped: connection_emailbison_stats_read, action campaign
GET/campaigns/{campaign_id}/line-area-chart-stats

Campaign stats by day

connection_emailbison_get_campaign_daily_statsgrouped: connection_emailbison_stats_read, action campaign_daily
GET/campaign-events/stats

Event stats by day, campaign and mailbox

connection_emailbison_get_campaign_event_statsgrouped: connection_emailbison_stats_read, action events_daily
GET/campaigns/{campaign_id}/schedule

Get a campaign's schedule

connection_emailbison_get_campaign_schedulegrouped: connection_emailbison_schedules_read, action get
POST/campaigns/{campaign_id}/schedule

Create a campaign's schedule

connection_emailbison_create_campaign_schedulegrouped: connection_emailbison_schedules_write, action create
PUT/campaigns/{campaign_id}/schedule

Replace a campaign's schedule

connection_emailbison_update_campaign_schedulegrouped: connection_emailbison_schedules_write, action update
POST/campaigns/{campaign_id}/create-schedule-from-template

Schedule a campaign from a template

connection_emailbison_create_campaign_schedule_from_templategrouped: connection_emailbison_schedules_write, action from_template
GET/campaigns/schedule/templates

List schedule templates

connection_emailbison_list_schedule_templatesgrouped: connection_emailbison_schedules_read, action templates
GET/campaigns/schedule/available-timezones

List schedule timezones

connection_emailbison_list_schedule_timezonesgrouped: connection_emailbison_schedules_read, action timezones
GET/campaigns/sending-schedules

Sending plan for all campaigns

connection_emailbison_list_sending_schedulesgrouped: connection_emailbison_schedules_read, action sending_plan
GET/campaigns/{campaign_id}/sending-schedule

Sending plan for a campaign

connection_emailbison_get_campaign_sending_schedulegrouped: connection_emailbison_schedules_read, action campaign_sending_plan
GET/campaigns/v1.1/{campaign_id}/sequence-steps

List a campaign's sequence steps

connection_emailbison_list_sequence_stepsgrouped: connection_emailbison_campaigns_read, action sequence_steps
POST/campaigns/v1.1/{campaign_id}/sequence-steps

Create a campaign's sequence

connection_emailbison_create_sequence_stepsgrouped: connection_emailbison_sequences_write, action create
PUT/campaigns/v1.1/sequence-steps/{sequence_id}

Update a sequence's steps

connection_emailbison_update_sequence_stepsgrouped: connection_emailbison_sequences_write, action update
PATCH/campaigns/sequence-steps/{sequence_step_id}/activate-or-deactivate

Turn a step variant on or off

connection_emailbison_set_sequence_step_activegrouped: connection_emailbison_sequences_write, action set_variant_active
DELETE/campaigns/sequence-steps/{sequence_step_id}

Delete a sequence step

connection_emailbison_delete_sequence_stepgrouped: connection_emailbison_sequences_delete, action delete_step
GET/campaigns/{campaign_id}/leads

List a campaign's leads

connection_emailbison_list_campaign_leadsgrouped: connection_emailbison_campaign_leads_read, action list
DELETE/campaigns/{campaign_id}/leads

Remove leads from a campaign

connection_emailbison_remove_campaign_leadsgrouped: connection_emailbison_campaign_leads_delete, action remove
POST/campaigns/{campaign_id}/leads/attach-leads

Add leads to a campaign

connection_emailbison_add_leads_to_campaigngrouped: connection_emailbison_campaign_leads_write, action add
POST/campaigns/{campaign_id}/leads/attach-lead-list

Add a lead list to a campaign

connection_emailbison_add_lead_list_to_campaigngrouped: connection_emailbison_campaign_leads_write, action add_list
POST/campaigns/{campaign_id}/leads/stop-future-emails

Stop emails to leads in a campaign

connection_emailbison_stop_campaign_leadsgrouped: connection_emailbison_campaign_leads_delete, action stop
POST/campaigns/{campaign_id}/leads/move-to-another-campaign

Move leads to another campaign

connection_emailbison_move_campaign_leadsgrouped: connection_emailbison_campaign_leads_write, action move
GET/campaigns/{campaign_id}/scheduled-emails

List a campaign's scheduled and sent emails

connection_emailbison_list_campaign_scheduled_emailsgrouped: connection_emailbison_scheduled_emails_read, action by_campaign
GET/campaigns/{campaign_id}/replies

List a campaign's replies

connection_emailbison_list_campaign_repliesgrouped: connection_emailbison_replies_read, action by_campaign
GET/campaigns/{campaign_id}/sender-emails

List a campaign's sender emails

connection_emailbison_list_campaign_sender_emailsgrouped: connection_emailbison_campaigns_read, action sender_emails
POST/campaigns/{campaign_id}/attach-sender-emails

Add sender emails to a campaign

connection_emailbison_add_campaign_sender_emailsgrouped: connection_emailbison_campaigns_write, action add_sender_emails
DELETE/campaigns/{campaign_id}/remove-sender-emails

Remove sender emails from a campaign

connection_emailbison_remove_campaign_sender_emailsgrouped: connection_emailbison_campaigns_delete, action remove_sender_emails
GET/replies

List replies (master inbox)

connection_emailbison_list_repliesgrouped: connection_emailbison_replies_read, action list
GET/replies/{reply_id}

Get a reply

connection_emailbison_get_replygrouped: connection_emailbison_replies_read, action get
DELETE/replies/{reply_id}

Delete a reply

connection_emailbison_delete_replygrouped: connection_emailbison_replies_delete, action delete
GET/replies/{reply_id}/conversation-thread

Get a reply's thread

connection_emailbison_get_reply_threadgrouped: connection_emailbison_replies_read, action thread
POST/replies/{reply_id}/reply

Reply to an email

connection_emailbison_send_replygrouped: connection_emailbison_replies_send, action reply
POST/replies/{reply_id}/forward

Forward an email

connection_emailbison_forward_replygrouped: connection_emailbison_replies_send, action forward
POST/replies/new

Send a new one-off email

connection_emailbison_send_new_emailgrouped: connection_emailbison_replies_send, action send_new
PATCH/replies/{reply_id}/mark-as-interested

Mark a reply interested

connection_emailbison_mark_reply_interestedgrouped: connection_emailbison_replies_write, action mark_interested
PATCH/replies/{reply_id}/mark-as-not-interested

Mark a reply not interested

connection_emailbison_mark_reply_not_interestedgrouped: connection_emailbison_replies_write, action mark_not_interested
PATCH/replies/{reply_id}/mark-as-read-or-unread

Mark a reply read or unread

connection_emailbison_mark_reply_readgrouped: connection_emailbison_replies_write, action mark_read
PATCH/replies/{reply_id}/mark-as-automated-or-not-automated

Mark a reply automated or not

connection_emailbison_mark_reply_automatedgrouped: connection_emailbison_replies_write, action mark_automated
PATCH/replies/{reply_id}/unsubscribe

Unsubscribe the contact who replied

connection_emailbison_unsubscribe_reply_contactgrouped: connection_emailbison_replies_write, action unsubscribe
POST/replies/{reply_id}/followup-campaign/push

Follow up a reply through a campaign

connection_emailbison_push_reply_to_followup_campaigngrouped: connection_emailbison_replies_write, action follow_up
GET/leads

List leads

connection_emailbison_list_leadsgrouped: connection_emailbison_leads_read, action list
POST/leads

Create a lead

connection_emailbison_create_leadgrouped: connection_emailbison_leads_write, action create
GET/leads/{lead_id}

Get a lead

connection_emailbison_get_leadgrouped: connection_emailbison_leads_read, action get
PATCH/leads/{lead_id}

Update a lead

connection_emailbison_update_leadgrouped: connection_emailbison_leads_write, action update
DELETE/leads/{lead_id}

Delete a lead

connection_emailbison_delete_leadgrouped: connection_emailbison_leads_delete, action delete
POST/leads/multiple

Create up to 500 leads

connection_emailbison_create_leadsgrouped: connection_emailbison_leads_write, action create_bulk
POST/leads/create-or-update/multiple

Create or update up to 500 leads

connection_emailbison_upsert_leadsgrouped: connection_emailbison_leads_write, action upsert_bulk
PATCH/leads/{lead_id}/update-status

Set a lead's status

connection_emailbison_update_lead_statusgrouped: connection_emailbison_leads_write, action set_status
PATCH/leads/bulk-update-status

Set the status of several leads

connection_emailbison_bulk_update_lead_statusgrouped: connection_emailbison_leads_write, action set_status_bulk
PATCH/leads/{lead_id}/unsubscribe

Unsubscribe a lead

connection_emailbison_unsubscribe_leadgrouped: connection_emailbison_leads_write, action unsubscribe
POST/leads/{lead_id}/blacklist

Blacklist a lead

connection_emailbison_blacklist_leadgrouped: connection_emailbison_blacklist_write, action add_lead
DELETE/leads/bulk

Delete several leads

connection_emailbison_bulk_delete_leadsgrouped: connection_emailbison_leads_delete, action delete_bulk
GET/leads/{lead_id}/replies

List a lead's replies

connection_emailbison_list_lead_repliesgrouped: connection_emailbison_replies_read, action by_lead
GET/leads/{lead_id}/scheduled-emails

List a lead's scheduled emails

connection_emailbison_list_lead_scheduled_emailsgrouped: connection_emailbison_scheduled_emails_read, action by_lead
GET/leads/{lead_id}/sent-emails

List a lead's sent emails

connection_emailbison_list_lead_sent_emailsgrouped: connection_emailbison_scheduled_emails_read, action sent_to_lead
GET/lead-lists

List lead lists

connection_emailbison_list_lead_listsgrouped: connection_emailbison_lead_lists_read, action list
POST/lead-lists

Create a lead list

connection_emailbison_create_lead_listgrouped: connection_emailbison_lead_lists_write, action create
GET/lead-lists/{lead_list_id}

Get a lead list

connection_emailbison_get_lead_listgrouped: connection_emailbison_lead_lists_read, action get
PUT/lead-lists/{lead_list_id}

Rename a lead list

connection_emailbison_rename_lead_listgrouped: connection_emailbison_lead_lists_write, action rename
GET/custom-variables

List custom variables

connection_emailbison_list_custom_variablesgrouped: connection_emailbison_leads_read, action custom_variables
POST/custom-variables

Create a custom variable

connection_emailbison_create_custom_variablegrouped: connection_emailbison_leads_write, action create_custom_variable
DELETE/custom-variables/{custom_variable_id}

Delete a custom variable

connection_emailbison_delete_custom_variablegrouped: connection_emailbison_leads_delete, action delete_custom_variable
GET/tags

List tags

connection_emailbison_list_tagsgrouped: connection_emailbison_tags_read, action list
POST/tags

Create a tag

connection_emailbison_create_taggrouped: connection_emailbison_tags_write, action create
GET/tags/{tag_id}

Get a tag

connection_emailbison_get_taggrouped: connection_emailbison_tags_read, action get
DELETE/tags/{tag_id}

Delete a tag

connection_emailbison_delete_taggrouped: connection_emailbison_tags_delete, action delete
POST/tags/attach-to-campaigns

Tag campaigns

connection_emailbison_attach_tags_to_campaignsgrouped: connection_emailbison_tags_write, action tag_campaigns
POST/tags/remove-from-campaigns

Untag campaigns

connection_emailbison_remove_tags_from_campaignsgrouped: connection_emailbison_tags_write, action untag_campaigns
POST/tags/attach-to-leads

Tag leads

connection_emailbison_attach_tags_to_leadsgrouped: connection_emailbison_tags_write, action tag_leads
POST/tags/remove-from-leads

Untag leads

connection_emailbison_remove_tags_from_leadsgrouped: connection_emailbison_tags_write, action untag_leads
POST/tags/attach-to-sender-emails

Tag sender emails

connection_emailbison_attach_tags_to_sender_emailsgrouped: connection_emailbison_tags_write, action tag_sender_emails
POST/tags/remove-from-sender-emails

Untag sender emails

connection_emailbison_remove_tags_from_sender_emailsgrouped: connection_emailbison_tags_write, action untag_sender_emails
GET/scheduled-emails

List scheduled and sent emails

connection_emailbison_list_scheduled_emailsgrouped: connection_emailbison_scheduled_emails_read, action list
GET/scheduled-emails/{scheduled_email_id}

Get a scheduled email

connection_emailbison_get_scheduled_emailgrouped: connection_emailbison_scheduled_emails_read, action get
GET/events

List events (last 10 days)

connection_emailbison_list_eventsgrouped: connection_emailbison_webhooks_read, action events
GET/events/{event_id}

Get an event

connection_emailbison_get_eventgrouped: connection_emailbison_webhooks_read, action event
GET/sender-emails

List sender emails

connection_emailbison_list_sender_emailsgrouped: connection_emailbison_sender_emails_read, action list
GET/sender-emails/{sender_email_id}

Get a sender email

connection_emailbison_get_sender_emailgrouped: connection_emailbison_sender_emails_read, action get
PATCH/sender-emails/{sender_email_id}

Update a sender email

connection_emailbison_update_sender_emailgrouped: connection_emailbison_sender_emails_write, action update
DELETE/sender-emails/{sender_email_id}

Delete a sender email

connection_emailbison_delete_sender_emailgrouped: connection_emailbison_sender_emails_delete, action delete
GET/sender-emails/{sender_email_id}/campaigns

List a sender email's campaigns

connection_emailbison_list_sender_email_campaignsgrouped: connection_emailbison_sender_emails_read, action campaigns
GET/sender-emails/{sender_email_id}/replies

List a sender email's replies

connection_emailbison_list_sender_email_repliesgrouped: connection_emailbison_replies_read, action by_sender_email
PATCH/sender-emails/signatures/bulk

Set the signature of several sender emails

connection_emailbison_bulk_update_sender_signaturesgrouped: connection_emailbison_sender_emails_write, action set_signatures
PATCH/sender-emails/daily-limits/bulk

Set the daily limit of several sender emails

connection_emailbison_bulk_update_sender_daily_limitsgrouped: connection_emailbison_sender_emails_write, action set_daily_limits
POST/sender-emails/{sender_email_id}/check-mx-records

Check a sender email's MX records

connection_emailbison_check_sender_email_mx_recordsgrouped: connection_emailbison_sender_emails_write, action check_mx
POST/sender-emails/bulk-check-missing-mx-records

Recheck mailboxes missing MX records

connection_emailbison_check_missing_mx_recordsgrouped: connection_emailbison_sender_emails_write, action recheck_missing_mx
POST/sender-emails/{sender_email_id}/move-to-another-workspace

Move a sender email to another workspace

connection_emailbison_move_sender_email_to_workspacegrouped: connection_emailbison_sender_emails_write, action move
POST/sender-emails/move-to-another-workspace-bulk

Move several sender emails to another workspace

connection_emailbison_move_sender_emails_to_workspacegrouped: connection_emailbison_sender_emails_write, action move_bulk
GET/warmup/sender-emails

List mailbox warmup stats

connection_emailbison_list_warmup_sender_emailsgrouped: connection_emailbison_warmup_read, action list
GET/warmup/sender-emails/{sender_email_id}

Get one mailbox's warmup stats

connection_emailbison_get_warmup_sender_emailgrouped: connection_emailbison_warmup_read, action get
PATCH/warmup/sender-emails/enable

Turn warmup on

connection_emailbison_enable_warmupgrouped: connection_emailbison_warmup_write, action enable
PATCH/warmup/sender-emails/disable

Turn warmup off

connection_emailbison_disable_warmupgrouped: connection_emailbison_warmup_write, action disable
PATCH/warmup/sender-emails/update-daily-warmup-limits

Set daily warmup limits

connection_emailbison_update_warmup_daily_limitsgrouped: connection_emailbison_warmup_write, action set_daily_limits
GET/blacklisted-emails

List blacklisted email addresses

connection_emailbison_list_blacklisted_emailsgrouped: connection_emailbison_blacklist_read, action list_emails
POST/blacklisted-emails

Blacklist an email address

connection_emailbison_add_blacklisted_emailgrouped: connection_emailbison_blacklist_write, action add_email
GET/blacklisted-emails/{blacklisted_email}

Get a blacklisted email address

connection_emailbison_get_blacklisted_emailgrouped: connection_emailbison_blacklist_read, action get_email
DELETE/blacklisted-emails/{blacklisted_email}

Remove a blacklisted email address

connection_emailbison_remove_blacklisted_emailgrouped: connection_emailbison_blacklist_delete, action remove_email
GET/blacklisted-domains

List blacklisted domains

connection_emailbison_list_blacklisted_domainsgrouped: connection_emailbison_blacklist_read, action list_domains
POST/blacklisted-domains

Blacklist a domain

connection_emailbison_add_blacklisted_domaingrouped: connection_emailbison_blacklist_write, action add_domain
GET/blacklisted-domains/{blacklisted_domain}

Get a blacklisted domain

connection_emailbison_get_blacklisted_domaingrouped: connection_emailbison_blacklist_read, action get_domain
DELETE/blacklisted-domains/{blacklisted_domain}

Remove a blacklisted domain

connection_emailbison_remove_blacklisted_domaingrouped: connection_emailbison_blacklist_delete, action remove_domain
GET/webhook-url

List webhooks

connection_emailbison_list_webhooksgrouped: connection_emailbison_webhooks_read, action list
POST/webhook-url

Create a webhook

connection_emailbison_create_webhookgrouped: connection_emailbison_webhooks_write, action create
GET/webhook-url/{webhook_id}

Get a webhook

connection_emailbison_get_webhookgrouped: connection_emailbison_webhooks_read, action get
PUT/webhook-url/{webhook_id}

Update a webhook

connection_emailbison_update_webhookgrouped: connection_emailbison_webhooks_write, action update
DELETE/webhook-url/{webhook_id}

Delete a webhook

connection_emailbison_delete_webhookgrouped: connection_emailbison_webhooks_delete, action delete
GET/webhook-events/event-types

List webhook event types

connection_emailbison_list_webhook_event_typesgrouped: connection_emailbison_webhooks_read, action event_types
GET/webhook-events/sample-payload

Get a sample webhook payload

connection_emailbison_get_webhook_sample_payloadgrouped: connection_emailbison_webhooks_read, action sample_payload
GET/webhook-deliveries/{delivery_id}

Get a webhook delivery

connection_emailbison_get_webhook_deliverygrouped: connection_emailbison_webhooks_read, action delivery
GET/webhook-attempts/{attempt_id}

Get a webhook attempt

connection_emailbison_get_webhook_attemptgrouped: connection_emailbison_webhooks_read, action attempt
POST/webhook-attempts/{attempt_id}/retry

Retry a webhook attempt

connection_emailbison_retry_webhook_attemptgrouped: connection_emailbison_webhooks_write, action retry_attempt