AptlyStar

Email Bison

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.

ツール

emailbison_list_leads

Retrieves leads from Email Bison with optional search and tag filters.

入力

パラメータ型必須説明
searchstringいいえSearch term for filtering leads
campaignStatusstringいいえLead campaign status filter: in_sequence, sequence_finished, sequence_stopped, never_contacted, or replied
tagIdsarrayいいえTag IDs to include
itemsnumberいいえNo description
excludedTagIdsarrayいいえTag IDs to exclude
itemsnumberいいえNo description
withoutTagsbooleanいいえOnly return leads without tags

出力

パラメータ型説明
leadsarrayList of leads
campaignsarrayList of campaigns
repliesarrayList of replies
tagsarrayList of tags
countnumberNumber of returned records
idnumberRecord ID
uuidstringRecord UUID
namestringCampaign or tag name
first_namestringLead first name
last_namestringLead last name
emailstringLead email address
statusstringRecord status
successbooleanWhether the action succeeded
messagestringAction message

emailbison_get_lead

Retrieves a lead by Email Bison lead ID or email address.

入力

パラメータ型必須説明
leadIdstringはいLead ID or email address

出力

パラメータ型説明
leadsarrayList of leads
campaignsarrayList of campaigns
repliesarrayList of replies
tagsarrayList of tags
countnumberNumber of returned records
idnumberRecord ID
uuidstringRecord UUID
namestringCampaign or tag name
first_namestringLead first name
last_namestringLead last name
emailstringLead email address
statusstringRecord status
successbooleanWhether the action succeeded
messagestringAction message

emailbison_create_lead

Creates a single lead in Email Bison.

入力

パラメータ型必須説明
firstNamestringはいLead first name
lastNamestringはいLead last name
emailstringはいLead email address
titlestringいいえLead job title
companystringいいえLead company
notesstringいいえAdditional notes about the lead
customVariablesarrayいいえCustom variables to store on the lead
itemsobjectいいえCustom variable name
propertiesstringいいえCustom variable name
namestringいいえNo description
valuestringいいえNo description

出力

パラメータ型説明
leadsarrayList of leads
campaignsarrayList of campaigns
repliesarrayList of replies
tagsarrayList of tags
countnumberNumber of returned records
idnumberRecord ID
uuidstringRecord UUID
namestringCampaign or tag name
first_namestringLead first name
last_namestringLead last name
emailstringLead email address
statusstringRecord status
successbooleanWhether the action succeeded
messagestringAction message

emailbison_update_lead

Updates an existing Email Bison lead. Fields omitted from a PUT update may be cleared by Email Bison.

入力

パラメータ型必須説明
leadIdstringはいLead ID or email address
firstNamestringはいLead first name
lastNamestringはいLead last name
emailstringはいLead email address
titlestringいいえLead job title
companystringいいえLead company
notesstringいいえAdditional notes about the lead
customVariablesarrayいいえCustom variables to store on the lead
itemsobjectいいえCustom variable name
propertiesstringいいえCustom variable name
namestringいいえNo description
valuestringいいえNo description

出力

パラメータ型説明
leadsarrayList of leads
campaignsarrayList of campaigns
repliesarrayList of replies
tagsarrayList of tags
countnumberNumber of returned records
idnumberRecord ID
uuidstringRecord UUID
namestringCampaign or tag name
first_namestringLead first name
last_namestringLead last name
emailstringLead email address
statusstringRecord status
successbooleanWhether the action succeeded
messagestringAction message

emailbison_list_campaigns

Retrieves Email Bison campaigns.

入力

パラメータ型必須説明

出力

パラメータ型説明
leadsarrayList of leads
campaignsarrayList of campaigns
repliesarrayList of replies
tagsarrayList of tags
countnumberNumber of returned records
idnumberRecord ID
uuidstringRecord UUID
namestringCampaign or tag name
first_namestringLead first name
last_namestringLead last name
emailstringLead email address
statusstringRecord status
successbooleanWhether the action succeeded
messagestringAction message

emailbison_create_campaign

Creates a new Email Bison campaign.

入力

パラメータ型必須説明
namestringはいCampaign name
campaignTypestringいいえCampaign type: outbound or reply_followup

出力

パラメータ型説明
leadsarrayList of leads
campaignsarrayList of campaigns
repliesarrayList of replies
tagsarrayList of tags
countnumberNumber of returned records
idnumberRecord ID
uuidstringRecord UUID
namestringCampaign or tag name
first_namestringLead first name
last_namestringLead last name
emailstringLead email address
statusstringRecord status
successbooleanWhether the action succeeded
messagestringAction message

emailbison_update_campaign

Updates Email Bison campaign settings.

入力

パラメータ型必須説明
campaignIdnumberはいCampaign ID
namestringいいえCampaign name
maxEmailsPerDaynumberいいえMaximum emails per day
maxNewLeadsPerDaynumberいいえMaximum new leads per day
plainTextbooleanいいえSend plain text emails
openTrackingbooleanいいえEnable open tracking
reputationBuildingbooleanいいえEnable reputation building
canUnsubscribebooleanいいえEnable unsubscribe link
includeAutoRepliesInStatsbooleanいいえInclude auto replies in campaign stats
sequencePrioritizationstringいいえSequence prioritization: followups or new_leads

出力

パラメータ型説明
leadsarrayList of leads
campaignsarrayList of campaigns
repliesarrayList of replies
tagsarrayList of tags
countnumberNumber of returned records
idnumberRecord ID
uuidstringRecord UUID
namestringCampaign or tag name
first_namestringLead first name
last_namestringLead last name
emailstringLead email address
statusstringRecord status
successbooleanWhether the action succeeded
messagestringAction message

emailbison_update_campaign_status

Pauses, resumes, or archives an Email Bison campaign.

入力

パラメータ型必須説明
campaignIdnumberはいCampaign ID
actionstringはいStatus action: pause, resume, or archive

出力

パラメータ型説明
leadsarrayList of leads
campaignsarrayList of campaigns
repliesarrayList of replies
tagsarrayList of tags
countnumberNumber of returned records
idnumberRecord ID
uuidstringRecord UUID
namestringCampaign or tag name
first_namestringLead first name
last_namestringLead last name
emailstringLead email address
statusstringRecord status
successbooleanWhether the action succeeded
messagestringAction message

emailbison_attach_leads_to_campaign

Adds existing Email Bison leads to a campaign.

入力

パラメータ型必須説明
campaignIdnumberはいCampaign ID
leadIdsarrayはいLead IDs to add to the campaign
itemsnumberいいえNo description
allowParallelSendingbooleanいいえForce add leads already in sequence in other campaigns

出力

パラメータ型説明
leadsarrayList of leads
campaignsarrayList of campaigns
repliesarrayList of replies
tagsarrayList of tags
countnumberNumber of returned records
idnumberRecord ID
uuidstringRecord UUID
namestringCampaign or tag name
first_namestringLead first name
last_namestringLead last name
emailstringLead email address
statusstringRecord status
successbooleanWhether the action succeeded
messagestringAction message

emailbison_list_replies

Retrieves Email Bison replies with optional status, folder, campaign, sender, lead, and tag filters.

入力

パラメータ型必須説明
searchstringいいえSearch term for replies
statusstringいいえReply status: interested, automated_reply, or not_automated_reply
folderstringいいえReply folder: inbox, sent, spam, bounced, or all
readbooleanいいえFilter by read state
campaignIdnumberいいえCampaign ID
senderEmailIdnumberいいえSender email ID
leadIdnumberいいえLead ID
tagIdsarrayいいえTag IDs to filter replies by
itemsnumberいいえNo description

出力

パラメータ型説明
leadsarrayList of leads
campaignsarrayList of campaigns
repliesarrayList of replies
tagsarrayList of tags
countnumberNumber of returned records
idnumberRecord ID
uuidstringRecord UUID
namestringCampaign or tag name
first_namestringLead first name
last_namestringLead last name
emailstringLead email address
statusstringRecord status
successbooleanWhether the action succeeded
messagestringAction message

emailbison_list_tags

Retrieves all Email Bison tags for the authenticated workspace.

入力

パラメータ型必須説明

出力

パラメータ型説明
leadsarrayList of leads
campaignsarrayList of campaigns
repliesarrayList of replies
tagsarrayList of tags
countnumberNumber of returned records
idnumberRecord ID
uuidstringRecord UUID
namestringCampaign or tag name
first_namestringLead first name
last_namestringLead last name
emailstringLead email address
statusstringRecord status
successbooleanWhether the action succeeded
messagestringAction message

emailbison_create_tag

Creates a new Email Bison tag.

入力

パラメータ型必須説明
namestringはいTag name

出力

パラメータ型説明
leadsarrayList of leads
campaignsarrayList of campaigns
repliesarrayList of replies
tagsarrayList of tags
countnumberNumber of returned records
idnumberRecord ID
uuidstringRecord UUID
namestringCampaign or tag name
first_namestringLead first name
last_namestringLead last name
emailstringLead email address
statusstringRecord status
successbooleanWhether the action succeeded
messagestringAction message

emailbison_attach_tags_to_leads

Attaches Email Bison tags to one or more leads.

入力

パラメータ型必須説明
tagIdsarrayはいTag IDs to attach
itemsnumberいいえNo description
leadIdsarrayはいLead IDs to tag
itemsnumberいいえNo description
skipWebhooksbooleanいいえSkip Email Bison webhooks for this action

出力

パラメータ型説明
leadsarrayList of leads
campaignsarrayList of campaigns
repliesarrayList of replies
tagsarrayList of tags
countnumberNumber of returned records
idnumberRecord ID
uuidstringRecord UUID
namestringCampaign or tag name
first_namestringLead first name
last_namestringLead last name
emailstringLead email address
statusstringRecord status
successbooleanWhether the action succeeded
messagestringAction message

On this page