Email Bison
App · 25 actions
Manage Email Bison campaigns, leads, sequences and tags; inspect replies, senders and statistics.
Actions
| Action | What it does |
|---|---|
| Attach campaign leads | Import leads by IDs. |
| Create campaign | Create a campaign. |
| Create lead | Create lead. |
| Create tag | Create tag. |
| Delete campaign | Delete a campaign. |
| Delete lead | Delete a lead. |
| Delete tag | Remove tag. |
| Get account | Account Details. |
| Get campaign | Campaign details. |
| Get campaign stats | Get campaign stats (summary). |
| Get lead | Get single lead. |
| Get sequence steps | View campaign sequence steps (v1.1). |
| Get tag | View tag. |
| List campaign leads | Get all leads for campaign. |
| List campaign replies | Get campaign replies. |
| List campaigns | List campaigns. |
| List email accounts | List email accounts. |
| List leads | Get all leads. |
| List tags | Get all tags for workspace. |
| Pause campaign | Pause campaign. |
| Resume campaign | Resume campaign. |
| Set sequence steps | Create sequence steps (v1.1). |
| Unsubscribe lead | Unsubscribe lead. |
| Update campaign | Update campaign settings. |
| Update lead | Update lead. |
Attach campaign leads
Import leads by IDs.
Inputs
- Campaign
campaign_idnumberRequired - The ID of the campaign.
- Allow parallel sending
allow_parallel_sendingtrue/false - Force add leads that are "In Sequence" in other campaigns.
- Lead IDS
lead_idslistRequired - An array of lead IDs to import.
Outputs
dataobject- Complete Email Bison response with resource data and pagination.
has_moretrue/false- Whether the service reports another page.
next_cursortext- Cursor for the next page, when supplied by the service.
Example output
{
"data": {
"data": {
"message": "",
"success": false
}
},
"has_more": false,
"next_cursor": ""
}Create campaign
Create a campaign.
Inputs
- Name
nametextRequired - The name of the new campaign.
- Type
typetext - optional The type of campaign. Default is `outbound`One of:
outbound,reply_followup.
Outputs
dataobject- Complete Email Bison response with resource data and pagination.
has_moretrue/false- Whether the service reports another page.
next_cursortext- Cursor for the next page, when supplied by the service.
Example output
{
"data": {
"data": {
"bounced": 0,
"can_unsubscribe": false,
"created_at": "",
"emails_sent": 0,
"id": 0,
"interested": 0,
"max_emails_per_day": 0,
"max_new_leads_per_day": 0,
"name": "",
"open_tracking": false,
"opened": 0,
"plain_text": false,
"replied": 0,
"status": "",
"tags": [],
"total_leads": 0,
"total_leads_contacted": 0,
"type": "",
"unique_opens": 0,
"unique_replies": 0,
"unsubscribe_text": "",
"unsubscribed": 0,
"updated_at": "",
"uuid": ""
}
},
"has_more": false,
"next_cursor": ""
}Create lead
Create lead.
Inputs
- First name
first_nametextRequired - The first name of the contact.
- Last name
last_nametext - optional The last name of the contact.
- Email
emailtextRequired - The email address of the contact. Must be unique and in a valid email format.
- Title
titletext - optional The title of the contact.
- Company
companytext - optional The company name of the contact.
- Notes
notestext - optional Additional notes about the contact.
- Custom variables
custom_variableslist - optional Array of custom variable objects
Outputs
dataobject- Complete Email Bison response with resource data and pagination.
has_moretrue/false- Whether the service reports another page.
next_cursortext- Cursor for the next page, when supplied by the service.
Example output
{
"data": {},
"has_more": false,
"next_cursor": ""
}Create tag
Create tag.
Inputs
- Name
nametextRequired - The name of the tag.
Outputs
dataobject- Complete Email Bison response with resource data and pagination.
has_moretrue/false- Whether the service reports another page.
next_cursortext- Cursor for the next page, when supplied by the service.
Example output
{
"data": {},
"has_more": false,
"next_cursor": ""
}Delete campaign
Delete a campaign.
Inputs
- Campaign
campaign_idnumberRequired - The ID of the campaign.
Outputs
dataobject- Complete Email Bison response with resource data and pagination.
has_moretrue/false- Whether the service reports another page.
next_cursortext- Cursor for the next page, when supplied by the service.
Example output
{
"data": {
"data": {
"message": "",
"success": false
}
},
"has_more": false,
"next_cursor": ""
}Delete lead
Delete a lead.
Inputs
- Lead ID
lead_idtextRequired - Optional parameter. int|string The ID or email of the lead
Outputs
dataobject- Complete Email Bison response with resource data and pagination.
has_moretrue/false- Whether the service reports another page.
next_cursortext- Cursor for the next page, when supplied by the service.
Example output
{
"data": {
"data": {
"message": "",
"success": false
}
},
"has_more": false,
"next_cursor": ""
}Delete tag
Remove tag.
Inputs
- Tag ID
tag_idnumberRequired - The ID of the tag
Outputs
dataobject- Complete Email Bison response with resource data and pagination.
has_moretrue/false- Whether the service reports another page.
next_cursortext- Cursor for the next page, when supplied by the service.
Example output
{
"data": {
"data": {
"message": "",
"success": false
}
},
"has_more": false,
"next_cursor": ""
}Get account
Account Details.
Inputs
None.
Outputs
dataobject- Complete Email Bison response with resource data and pagination.
has_moretrue/false- Whether the service reports another page.
next_cursortext- Cursor for the next page, when supplied by the service.
Example output
{
"data": {
"data": {
"created_at": "",
"email": "",
"id": 0,
"name": "",
"profile_photo_path": null,
"profile_photo_url": "",
"team": {
"created_at": "",
"id": 0,
"main": false,
"name": "",
"parent_id": null,
"personal_team": false,
"updated_at": ""
},
"updated_at": ""
}
},
"has_more": false,
"next_cursor": ""
}Get campaign
Campaign details.
Inputs
- ID
idnumberRequired - The ID of the campaign.
Outputs
dataobject- Complete Email Bison response with resource data and pagination.
has_moretrue/false- Whether the service reports another page.
next_cursortext- Cursor for the next page, when supplied by the service.
Example output
{
"data": {},
"has_more": false,
"next_cursor": ""
}Get campaign stats
Get campaign stats (summary).
Inputs
- Campaign
campaign_idnumberRequired - The ID of the campaign.
- Start date
start_datedateRequired - The start date to fetch stats.
- End date
end_datedateRequired - The end date to fetch stats.
Outputs
dataobject- Complete Email Bison response with resource data and pagination.
has_moretrue/false- Whether the service reports another page.
next_cursortext- Cursor for the next page, when supplied by the service.
Example output
{
"data": {
"data": {
"bounced": "",
"bounced_percentage": "",
"emails_sent": "",
"interested": "",
"interested_percentage": "",
"opened": "",
"opened_percentage": "",
"sequence_step_stats": [],
"total_leads_contacted": "",
"unique_opens_per_contact": "",
"unique_opens_per_contact_percentage": "",
"unique_replies_per_contact": "",
"unique_replies_per_contact_percentage": "",
"unsubscribed": "",
"unsubscribed_percentage": ""
}
},
"has_more": false,
"next_cursor": ""
}Get lead
Get single lead.
Inputs
- Lead ID
lead_idtextRequired - Optional parameter. int|string The ID or email of the lead
Outputs
dataobject- Complete Email Bison response with resource data and pagination.
has_moretrue/false- Whether the service reports another page.
next_cursortext- Cursor for the next page, when supplied by the service.
Example output
{
"data": {},
"has_more": false,
"next_cursor": ""
}Get sequence steps
View campaign sequence steps (v1.1).
Inputs
- Campaign
campaign_idnumberRequired - The ID of the campaign.
Outputs
dataobject- Complete Email Bison response with resource data and pagination.
has_moretrue/false- Whether the service reports another page.
next_cursortext- Cursor for the next page, when supplied by the service.
Example output
{
"data": {},
"has_more": false,
"next_cursor": ""
}Get tag
View tag.
Inputs
- ID
idnumberRequired - The ID of the tag.
Outputs
dataobject- Complete Email Bison response with resource data and pagination.
has_moretrue/false- Whether the service reports another page.
next_cursortext- Cursor for the next page, when supplied by the service.
Example output
{
"data": {},
"has_more": false,
"next_cursor": ""
}List campaign leads
Get all leads for campaign.
Inputs
- Campaign
campaign_idnumberRequired - The ID of the campaign.
- Search
searchtext - Search term for filtering replies.
- Filters lead campaign status
filters_lead_campaign_statustext - Filter by lead campaign status. One of `in_sequence`, `sequence_finished`, `sequence_stopped`, `never_contacted`, `replied`.One of:
in_sequence,sequence_finished,sequence_stopped,never_contacted,replied. - Filters emails sent criteria
filters_emails_sent_criteriatext - Comparison operator for emails sent. One of `=`, `>=`, `>`, `<=`, `<`.One of:
=,>=,>,<=,<. - Filters emails sent value
filters_emails_sent_valuenumber - Value for the number of emails sent.
- Filters opens criteria
filters_opens_criteriatext - Comparison operator for email opens. One of `=`, `>=`, `>`, `<=`, `<`.One of:
=,>=,>,<=,<. - Filters opens value
filters_opens_valuenumber - Value for the number of email opens.
- Filters replies criteria
filters_replies_criteriatext - Comparison operator for replies. One of `=`, `>=`, `>`, `<=`, `<`.One of:
=,>=,>,<=,<. - Filters replies value
filters_replies_valuenumber - Value for the number of replies.
- Filters verification statuses
filters_verification_statuseslist - A verification status. Accepted values: `verifying`, `verified`, `risky`, `unknown`, `unverified`, `inactive`, `bounced`, `unsubscribed`One or more of:
verifying,verified,risky,unknown,unverified,inactive,bounced,unsubscribed. - Filters tag IDS
filters_tag_idslist - Filter by tag IDs.
- Filters excluded tag IDS
filters_excluded_tag_idslist - Exclude leads by tag IDs.
- Filters without tags
filters_without_tagstrue/false - Only show leads that have no tags attached.
- Filters created at criteria
filters_created_at_criteriatext - Comparison operator for the created_at date. One of `=`, `>=`, `>`, `<=`, `<`.One of:
=,>=,>,<=,<. - Filters created at value
filters_created_at_valuedate - Value for the created_at date. Must be a valid date in YYYY-MM-DD format.
- Filters updated at criteria
filters_updated_at_criteriatext - Comparison operator for the updated_at date. One of `=`, `>=`, `>`, `<=`, `<`.One of:
=,>=,>,<=,<. - Filters updated at value
filters_updated_at_valuedate - Value for the updated_at date. Must be a valid date in YYYY-MM-DD format.
- Pagination type
pagination_typetext - Pagination type.One of:
cursor,length_aware. - Page
pagenumber - Page number from Next cursor. Starts at 1.At least 1.
Outputs
dataobject- Complete Email Bison response with resource data and pagination.
has_moretrue/false- Whether the service reports another page.
next_cursortext- Cursor for the next page, when supplied by the service.
Example output
{
"data": {
"data": [],
"links": {
"first": "",
"last": "",
"next": null,
"prev": null
},
"meta": {
"current_page": 0,
"from": 0,
"last_page": 0,
"links": [],
"path": "",
"per_page": 0,
"to": 0,
"total": 0
}
},
"has_more": false,
"next_cursor": ""
}List campaign replies
Get campaign replies.
Inputs
- Campaign
campaign_idnumberRequired - The ID of the campaign.
- Search
searchtext - Search term for filtering replies.
- Status
statustext - Filter by status. One of `interested`, `automated_reply`, `not_automated_reply`.One of:
interested,automated_reply,not_automated_reply. - Folder
foldertext - Filter by folder. One of `inbox`, `sent`, `spam`, `bounced`, `all`.One of:
inbox,sent,spam,bounced,all. - Read
readtrue/false - Filter by read status.
- Sender email ID
sender_email_idnumber - The ID of the sender email address.
- Lead ID
lead_idnumber - Must match an existing stored value.
- Tag IDS
tag_idslist - Array of tag IDs to filter by.
- Pagination type
pagination_typetext - Pagination type.One of:
cursor,length_aware. - Page
pagenumber - Page number from Next cursor. Starts at 1.At least 1.
Outputs
dataobject- Complete Email Bison response with resource data and pagination.
has_moretrue/false- Whether the service reports another page.
next_cursortext- Cursor for the next page, when supplied by the service.
Example output
{
"data": {},
"has_more": false,
"next_cursor": ""
}List campaigns
List campaigns.
Inputs
- Search
searchtext - Search.
- Status
statustext - Status.One of:
draft,launching,active,stopped,completed,paused,failed,queued,archived,pending deletion,deleted. - Tag IDS
tag_idslist - Must match an existing stored value.
- Pagination type
pagination_typetext - Pagination type.One of:
cursor,length_aware. - Page
pagenumber - Page number from Next cursor. Starts at 1.At least 1.
Outputs
dataobject- Complete Email Bison response with resource data and pagination.
has_moretrue/false- Whether the service reports another page.
next_cursortext- Cursor for the next page, when supplied by the service.
Example output
{
"data": {},
"has_more": false,
"next_cursor": ""
}List email accounts
List email accounts.
Inputs
- Search
searchtext - Search term for filter by.
- Tag IDS
tag_idslist - Array of tag IDs to filter by.
- Excluded tag IDS
excluded_tag_idslist - Exclude email accounts by tag IDs.
- Without tags
without_tagstrue/false - Only show email accounts that have no tags attached.
- Status
statustext - The status of the email account.One of:
connected,not_connected,pending_move,pending_deletion. - Warmup score filter warmup score day period
warmup_score_filter_warmup_score_day_periodtext - Cached date period One of `warmup_score_last_3_days`, `warmup_score_last_7_days`, `warmup_score_last_10_days`, `warmup_score_last_14_days`, `warmup_score_last_30_days`One of:
warmup_score_last_3_days,warmup_score_last_7_days,warmup_score_last_10_days,warmup_score_last_14_days,warmup_score_last_30_days. - Warmup score filter warmup score filtering criteria
warmup_score_filter_warmup_score_filtering_criteriatext - Comparison operator for warmup score. One of `=`, `>=`, `>`, `<=`, `<`.One of:
=,>=,>,<=,<. - Warmup score filter warmup score value
warmup_score_filter_warmup_score_valuenumber - Value for the warmup score.
- Pagination type
pagination_typetext - Pagination type.One of:
cursor,length_aware. - Page
pagenumber - Page number from Next cursor. Starts at 1.At least 1.
Outputs
dataobject- Complete Email Bison response with resource data and pagination.
has_moretrue/false- Whether the service reports another page.
next_cursortext- Cursor for the next page, when supplied by the service.
Example output
{
"data": {
"data": [],
"links": {
"first": "",
"last": "",
"next": null,
"prev": null
},
"meta": {
"current_page": 0,
"from": 0,
"last_page": 0,
"links": [],
"path": "",
"per_page": 0,
"to": 0,
"total": 0
}
},
"has_more": false,
"next_cursor": ""
}List leads
Get all leads.
Inputs
- Search
searchtext - Search term for filtering replies.
- Filters lead campaign status
filters_lead_campaign_statustext - Filter by lead campaign status. One of `in_sequence`, `sequence_finished`, `sequence_stopped`, `never_contacted`, `replied`.One of:
in_sequence,sequence_finished,sequence_stopped,never_contacted,replied. - Filters emails sent criteria
filters_emails_sent_criteriatext - Comparison operator for emails sent. One of `=`, `>=`, `>`, `<=`, `<`.One of:
=,>=,>,<=,<. - Filters emails sent value
filters_emails_sent_valuenumber - Value for the number of emails sent.
- Filters opens criteria
filters_opens_criteriatext - Comparison operator for email opens. One of `=`, `>=`, `>`, `<=`, `<`.One of:
=,>=,>,<=,<. - Filters opens value
filters_opens_valuenumber - Value for the number of email opens.
- Filters replies criteria
filters_replies_criteriatext - Comparison operator for replies. One of `=`, `>=`, `>`, `<=`, `<`.One of:
=,>=,>,<=,<. - Filters replies value
filters_replies_valuenumber - Value for the number of replies.
- Filters verification statuses
filters_verification_statuseslist - A verification status. Accepted values: `verifying`, `verified`, `risky`, `unknown`, `unverified`, `inactive`, `bounced`, `unsubscribed`One or more of:
verifying,verified,risky,unknown,unverified,inactive,bounced,unsubscribed. - Filters tag IDS
filters_tag_idslist - Filter by tag IDs.
- Filters excluded tag IDS
filters_excluded_tag_idslist - Exclude leads by tag IDs.
- Filters without tags
filters_without_tagstrue/false - Only show leads that have no tags attached.
- Filters created at criteria
filters_created_at_criteriatext - Comparison operator for the created_at date. One of `=`, `>=`, `>`, `<=`, `<`.One of:
=,>=,>,<=,<. - Filters created at value
filters_created_at_valuedate - Value for the created_at date. Must be a valid date in YYYY-MM-DD format.
- Filters updated at criteria
filters_updated_at_criteriatext - Comparison operator for the updated_at date. One of `=`, `>=`, `>`, `<=`, `<`.One of:
=,>=,>,<=,<. - Filters updated at value
filters_updated_at_valuedate - Value for the updated_at date. Must be a valid date in YYYY-MM-DD format.
- Pagination type
pagination_typetext - Pagination type.One of:
cursor,length_aware. - Page
pagenumber - Page number from Next cursor. Starts at 1.At least 1.
Outputs
dataobject- Complete Email Bison response with resource data and pagination.
has_moretrue/false- Whether the service reports another page.
next_cursortext- Cursor for the next page, when supplied by the service.
Example output
{
"data": {
"data": [],
"links": {
"first": "",
"last": "",
"next": null,
"prev": null
},
"meta": {
"current_page": 0,
"from": 0,
"last_page": 0,
"links": [],
"path": "",
"per_page": 0,
"to": 0,
"total": 0
}
},
"has_more": false,
"next_cursor": ""
}List tags
Get all tags for workspace.
Inputs
None.
Outputs
dataobject- Complete Email Bison response with resource data and pagination.
has_moretrue/false- Whether the service reports another page.
next_cursortext- Cursor for the next page, when supplied by the service.
Example output
{
"data": {
"data": []
},
"has_more": false,
"next_cursor": ""
}Pause campaign
Pause campaign.
Inputs
- Campaign
campaign_idnumberRequired - The ID of the campaign.
Outputs
dataobject- Complete Email Bison response with resource data and pagination.
has_moretrue/false- Whether the service reports another page.
next_cursortext- Cursor for the next page, when supplied by the service.
Example output
{
"data": {},
"has_more": false,
"next_cursor": ""
}Resume campaign
Resume campaign.
Inputs
- Campaign
campaign_idnumberRequired - The ID of the campaign.
Outputs
dataobject- Complete Email Bison response with resource data and pagination.
has_moretrue/false- Whether the service reports another page.
next_cursortext- Cursor for the next page, when supplied by the service.
Example output
{
"data": {},
"has_more": false,
"next_cursor": ""
}Set sequence steps
Create sequence steps (v1.1).
Inputs
- Campaign
campaign_idnumberRequired - The ID of the campaign.
- Title
titletextRequired - The title for the sequence.
- Sequence steps
sequence_stepslistRequired - The array containing the sequence steps
Outputs
dataobject- Complete Email Bison response with resource data and pagination.
has_moretrue/false- Whether the service reports another page.
next_cursortext- Cursor for the next page, when supplied by the service.
Example output
{
"data": {},
"has_more": false,
"next_cursor": ""
}Unsubscribe lead
Unsubscribe lead.
Inputs
- Lead ID
lead_idnumberRequired - The ID of the contact
Outputs
dataobject- Complete Email Bison response with resource data and pagination.
has_moretrue/false- Whether the service reports another page.
next_cursortext- Cursor for the next page, when supplied by the service.
Example output
{
"data": {},
"has_more": false,
"next_cursor": ""
}Update campaign
Update campaign settings.
Inputs
- ID
idnumberRequired - The ID of the campaign.
- Name
nametext - The name of the campaign.
- Max emails per day
max_emails_per_daynumber - The maximum number of emails that can be sent per day.
- Max new leads per day
max_new_leads_per_daynumber - The maximum number of new leads that can be added per day.
- Daily max sends per receiving domain
daily_max_sends_per_receiving_domainnumber - The maximum number of emails that can be sent per day to a single receiving domain.
- Plain text
plain_texttrue/false - Whether the email content should be plain text. If nothing sent, false is assumed.
- Open tracking
open_trackingtrue/false - Whether open tracking should be enabled for the campaign. If nothing sent, false is assumed.
- Reputation building
reputation_buildingtrue/false - Spam protection. If nothing sent, false is assumed.
- Can unsubscribe
can_unsubscribetrue/false - Whether recipients can unsubscribe from the campaign using a one-click link. If nothing sent, false is assumed.
- Include auto replies in stats
include_auto_replies_in_statstrue/false - If auto replies should be included in the campaign stats. This setting is not retroactive.
- Sequence prioritization
sequence_prioritizationtext - How the campaign sequence should be prioritized. By default, followups are prioritized.One of:
followups,new_leads.
Outputs
dataobject- Complete Email Bison response with resource data and pagination.
has_moretrue/false- Whether the service reports another page.
next_cursortext- Cursor for the next page, when supplied by the service.
Example output
{
"data": {},
"has_more": false,
"next_cursor": ""
}Update lead
Update lead.
Inputs
- Lead ID
lead_idtextRequired - Optional parameter. int|string The ID or email of the lead
- First name
first_nametext - The first name of the contact.
- Last name
last_nametext - The last name of the contact.
- Email
emailtext - The email address of the contact. Must be in a valid email format.
- Title
titletext - The title of the contact.
- Company
companytext - The company name of the contact.
- Notes
notestext - Additional notes about the contact.
- Custom variables
custom_variableslist - Array of custom variable objects
Outputs
dataobject- Complete Email Bison response with resource data and pagination.
has_moretrue/false- Whether the service reports another page.
next_cursortext- Cursor for the next page, when supplied by the service.
Example output
{
"data": {},
"has_more": false,
"next_cursor": ""
}