Manage Email Bison leads, campaigns, replies, and tags
Integrate Email Bison into workflows. Create and update leads, manage campaigns, attach leads to campaigns, list replies, and organize leads with tags.
Retrieves leads from Email Bison with optional search and tag filters.
| パラメータ | 型 | 必須 | 説明 |
|---|
search | string | いいえ | Search term for filtering leads |
campaignStatus | string | いいえ | Lead campaign status filter: in_sequence, sequence_finished, sequence_stopped, never_contacted, or replied |
tagIds | array | いいえ | Tag IDs to include |
items | number | いいえ | No description |
excludedTagIds | array | いいえ | Tag IDs to exclude |
items | number | いいえ | No description |
withoutTags | boolean | いいえ | Only return leads without tags |
| パラメータ | 型 | 説明 |
|---|
leads | array | List of leads |
campaigns | array | List of campaigns |
replies | array | List of replies |
tags | array | List of tags |
count | number | Number of returned records |
id | number | Record ID |
uuid | string | Record UUID |
name | string | Campaign or tag name |
first_name | string | Lead first name |
last_name | string | Lead last name |
email | string | Lead email address |
status | string | Record status |
success | boolean | Whether the action succeeded |
message | string | Action message |
Retrieves a lead by Email Bison lead ID or email address.
| パラメータ | 型 | 必須 | 説明 |
|---|
leadId | string | はい | Lead ID or email address |
| パラメータ | 型 | 説明 |
|---|
leads | array | List of leads |
campaigns | array | List of campaigns |
replies | array | List of replies |
tags | array | List of tags |
count | number | Number of returned records |
id | number | Record ID |
uuid | string | Record UUID |
name | string | Campaign or tag name |
first_name | string | Lead first name |
last_name | string | Lead last name |
email | string | Lead email address |
status | string | Record status |
success | boolean | Whether the action succeeded |
message | string | Action message |
Creates a single lead in Email Bison.
| パラメータ | 型 | 必須 | 説明 |
|---|
firstName | string | はい | Lead first name |
lastName | string | はい | Lead last name |
email | string | はい | Lead email address |
title | string | いいえ | Lead job title |
company | string | いいえ | Lead company |
notes | string | いいえ | Additional notes about the lead |
customVariables | array | いいえ | Custom variables to store on the lead |
items | object | いいえ | Custom variable name |
properties | string | いいえ | Custom variable name |
name | string | いいえ | No description |
value | string | いいえ | No description |
| パラメータ | 型 | 説明 |
|---|
leads | array | List of leads |
campaigns | array | List of campaigns |
replies | array | List of replies |
tags | array | List of tags |
count | number | Number of returned records |
id | number | Record ID |
uuid | string | Record UUID |
name | string | Campaign or tag name |
first_name | string | Lead first name |
last_name | string | Lead last name |
email | string | Lead email address |
status | string | Record status |
success | boolean | Whether the action succeeded |
message | string | Action message |
Updates an existing Email Bison lead. Fields omitted from a PUT update may be cleared by Email Bison.
| パラメータ | 型 | 必須 | 説明 |
|---|
leadId | string | はい | Lead ID or email address |
firstName | string | はい | Lead first name |
lastName | string | はい | Lead last name |
email | string | はい | Lead email address |
title | string | いいえ | Lead job title |
company | string | いいえ | Lead company |
notes | string | いいえ | Additional notes about the lead |
customVariables | array | いいえ | Custom variables to store on the lead |
items | object | いいえ | Custom variable name |
properties | string | いいえ | Custom variable name |
name | string | いいえ | No description |
value | string | いいえ | No description |
| パラメータ | 型 | 説明 |
|---|
leads | array | List of leads |
campaigns | array | List of campaigns |
replies | array | List of replies |
tags | array | List of tags |
count | number | Number of returned records |
id | number | Record ID |
uuid | string | Record UUID |
name | string | Campaign or tag name |
first_name | string | Lead first name |
last_name | string | Lead last name |
email | string | Lead email address |
status | string | Record status |
success | boolean | Whether the action succeeded |
message | string | Action message |
Retrieves Email Bison campaigns.
| パラメータ | 型 | 説明 |
|---|
leads | array | List of leads |
campaigns | array | List of campaigns |
replies | array | List of replies |
tags | array | List of tags |
count | number | Number of returned records |
id | number | Record ID |
uuid | string | Record UUID |
name | string | Campaign or tag name |
first_name | string | Lead first name |
last_name | string | Lead last name |
email | string | Lead email address |
status | string | Record status |
success | boolean | Whether the action succeeded |
message | string | Action message |
Creates a new Email Bison campaign.
| パラメータ | 型 | 必須 | 説明 |
|---|
name | string | はい | Campaign name |
campaignType | string | いいえ | Campaign type: outbound or reply_followup |
| パラメータ | 型 | 説明 |
|---|
leads | array | List of leads |
campaigns | array | List of campaigns |
replies | array | List of replies |
tags | array | List of tags |
count | number | Number of returned records |
id | number | Record ID |
uuid | string | Record UUID |
name | string | Campaign or tag name |
first_name | string | Lead first name |
last_name | string | Lead last name |
email | string | Lead email address |
status | string | Record status |
success | boolean | Whether the action succeeded |
message | string | Action message |
Updates Email Bison campaign settings.
| パラメータ | 型 | 必須 | 説明 |
|---|
campaignId | number | はい | Campaign ID |
name | string | いいえ | Campaign name |
maxEmailsPerDay | number | いいえ | Maximum emails per day |
maxNewLeadsPerDay | number | いいえ | Maximum new leads per day |
plainText | boolean | いいえ | Send plain text emails |
openTracking | boolean | いいえ | Enable open tracking |
reputationBuilding | boolean | いいえ | Enable reputation building |
canUnsubscribe | boolean | いいえ | Enable unsubscribe link |
includeAutoRepliesInStats | boolean | いいえ | Include auto replies in campaign stats |
sequencePrioritization | string | いいえ | Sequence prioritization: followups or new_leads |
| パラメータ | 型 | 説明 |
|---|
leads | array | List of leads |
campaigns | array | List of campaigns |
replies | array | List of replies |
tags | array | List of tags |
count | number | Number of returned records |
id | number | Record ID |
uuid | string | Record UUID |
name | string | Campaign or tag name |
first_name | string | Lead first name |
last_name | string | Lead last name |
email | string | Lead email address |
status | string | Record status |
success | boolean | Whether the action succeeded |
message | string | Action message |
Pauses, resumes, or archives an Email Bison campaign.
| パラメータ | 型 | 必須 | 説明 |
|---|
campaignId | number | はい | Campaign ID |
action | string | はい | Status action: pause, resume, or archive |
| パラメータ | 型 | 説明 |
|---|
leads | array | List of leads |
campaigns | array | List of campaigns |
replies | array | List of replies |
tags | array | List of tags |
count | number | Number of returned records |
id | number | Record ID |
uuid | string | Record UUID |
name | string | Campaign or tag name |
first_name | string | Lead first name |
last_name | string | Lead last name |
email | string | Lead email address |
status | string | Record status |
success | boolean | Whether the action succeeded |
message | string | Action message |
Adds existing Email Bison leads to a campaign.
| パラメータ | 型 | 必須 | 説明 |
|---|
campaignId | number | はい | Campaign ID |
leadIds | array | はい | Lead IDs to add to the campaign |
items | number | いいえ | No description |
allowParallelSending | boolean | いいえ | Force add leads already in sequence in other campaigns |
| パラメータ | 型 | 説明 |
|---|
leads | array | List of leads |
campaigns | array | List of campaigns |
replies | array | List of replies |
tags | array | List of tags |
count | number | Number of returned records |
id | number | Record ID |
uuid | string | Record UUID |
name | string | Campaign or tag name |
first_name | string | Lead first name |
last_name | string | Lead last name |
email | string | Lead email address |
status | string | Record status |
success | boolean | Whether the action succeeded |
message | string | Action message |
Retrieves Email Bison replies with optional status, folder, campaign, sender, lead, and tag filters.
| パラメータ | 型 | 必須 | 説明 |
|---|
search | string | いいえ | Search term for replies |
status | string | いいえ | Reply status: interested, automated_reply, or not_automated_reply |
folder | string | いいえ | Reply folder: inbox, sent, spam, bounced, or all |
read | boolean | いいえ | Filter by read state |
campaignId | number | いいえ | Campaign ID |
senderEmailId | number | いいえ | Sender email ID |
leadId | number | いいえ | Lead ID |
tagIds | array | いいえ | Tag IDs to filter replies by |
items | number | いいえ | No description |
| パラメータ | 型 | 説明 |
|---|
leads | array | List of leads |
campaigns | array | List of campaigns |
replies | array | List of replies |
tags | array | List of tags |
count | number | Number of returned records |
id | number | Record ID |
uuid | string | Record UUID |
name | string | Campaign or tag name |
first_name | string | Lead first name |
last_name | string | Lead last name |
email | string | Lead email address |
status | string | Record status |
success | boolean | Whether the action succeeded |
message | string | Action message |
Retrieves all Email Bison tags for the authenticated workspace.
| パラメータ | 型 | 説明 |
|---|
leads | array | List of leads |
campaigns | array | List of campaigns |
replies | array | List of replies |
tags | array | List of tags |
count | number | Number of returned records |
id | number | Record ID |
uuid | string | Record UUID |
name | string | Campaign or tag name |
first_name | string | Lead first name |
last_name | string | Lead last name |
email | string | Lead email address |
status | string | Record status |
success | boolean | Whether the action succeeded |
message | string | Action message |
Creates a new Email Bison tag.
| パラメータ | 型 | 必須 | 説明 |
|---|
name | string | はい | Tag name |
| パラメータ | 型 | 説明 |
|---|
leads | array | List of leads |
campaigns | array | List of campaigns |
replies | array | List of replies |
tags | array | List of tags |
count | number | Number of returned records |
id | number | Record ID |
uuid | string | Record UUID |
name | string | Campaign or tag name |
first_name | string | Lead first name |
last_name | string | Lead last name |
email | string | Lead email address |
status | string | Record status |
success | boolean | Whether the action succeeded |
message | string | Action message |
Attaches Email Bison tags to one or more leads.
| パラメータ | 型 | 必須 | 説明 |
|---|
tagIds | array | はい | Tag IDs to attach |
items | number | いいえ | No description |
leadIds | array | はい | Lead IDs to tag |
items | number | いいえ | No description |
skipWebhooks | boolean | いいえ | Skip Email Bison webhooks for this action |
| パラメータ | 型 | 説明 |
|---|
leads | array | List of leads |
campaigns | array | List of campaigns |
replies | array | List of replies |
tags | array | List of tags |
count | number | Number of returned records |
id | number | Record ID |
uuid | string | Record UUID |
name | string | Campaign or tag name |
first_name | string | Lead first name |
last_name | string | Lead last name |
email | string | Lead email address |
status | string | Record status |
success | boolean | Whether the action succeeded |
message | string | Action message |