AptlyStar

Email Bison

Manage Email Bison leads, campaigns, replies, and tags

Instructions d'utilisation

Integrate Email Bison into workflows. Create and update leads, manage campaigns, attach leads to campaigns, list replies, and organize leads with tags.

Outils

emailbison_list_leads

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

Entrée

ParamètreTypeObligatoireDescription
searchstringNonSearch term for filtering leads
campaignStatusstringNonLead campaign status filter: in_sequence, sequence_finished, sequence_stopped, never_contacted, or replied
tagIdsarrayNonTag IDs to include
itemsnumberNonNo description
excludedTagIdsarrayNonTag IDs to exclude
itemsnumberNonNo description
withoutTagsbooleanNonOnly return leads without tags

Sortie

ParamètreTypeDescription
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.

Entrée

ParamètreTypeObligatoireDescription
leadIdstringOuiLead ID or email address

Sortie

ParamètreTypeDescription
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.

Entrée

ParamètreTypeObligatoireDescription
firstNamestringOuiLead first name
lastNamestringOuiLead last name
emailstringOuiLead email address
titlestringNonLead job title
companystringNonLead company
notesstringNonAdditional notes about the lead
customVariablesarrayNonCustom variables to store on the lead
itemsobjectNonCustom variable name
propertiesstringNonCustom variable name
namestringNonNo description
valuestringNonNo description

Sortie

ParamètreTypeDescription
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.

Entrée

ParamètreTypeObligatoireDescription
leadIdstringOuiLead ID or email address
firstNamestringOuiLead first name
lastNamestringOuiLead last name
emailstringOuiLead email address
titlestringNonLead job title
companystringNonLead company
notesstringNonAdditional notes about the lead
customVariablesarrayNonCustom variables to store on the lead
itemsobjectNonCustom variable name
propertiesstringNonCustom variable name
namestringNonNo description
valuestringNonNo description

Sortie

ParamètreTypeDescription
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.

Entrée

ParamètreTypeObligatoireDescription

Sortie

ParamètreTypeDescription
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.

Entrée

ParamètreTypeObligatoireDescription
namestringOuiCampaign name
campaignTypestringNonCampaign type: outbound or reply_followup

Sortie

ParamètreTypeDescription
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.

Entrée

ParamètreTypeObligatoireDescription
campaignIdnumberOuiCampaign ID
namestringNonCampaign name
maxEmailsPerDaynumberNonMaximum emails per day
maxNewLeadsPerDaynumberNonMaximum new leads per day
plainTextbooleanNonSend plain text emails
openTrackingbooleanNonEnable open tracking
reputationBuildingbooleanNonEnable reputation building
canUnsubscribebooleanNonEnable unsubscribe link
includeAutoRepliesInStatsbooleanNonInclude auto replies in campaign stats
sequencePrioritizationstringNonSequence prioritization: followups or new_leads

Sortie

ParamètreTypeDescription
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.

Entrée

ParamètreTypeObligatoireDescription
campaignIdnumberOuiCampaign ID
actionstringOuiStatus action: pause, resume, or archive

Sortie

ParamètreTypeDescription
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.

Entrée

ParamètreTypeObligatoireDescription
campaignIdnumberOuiCampaign ID
leadIdsarrayOuiLead IDs to add to the campaign
itemsnumberNonNo description
allowParallelSendingbooleanNonForce add leads already in sequence in other campaigns

Sortie

ParamètreTypeDescription
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.

Entrée

ParamètreTypeObligatoireDescription
searchstringNonSearch term for replies
statusstringNonReply status: interested, automated_reply, or not_automated_reply
folderstringNonReply folder: inbox, sent, spam, bounced, or all
readbooleanNonFilter by read state
campaignIdnumberNonCampaign ID
senderEmailIdnumberNonSender email ID
leadIdnumberNonLead ID
tagIdsarrayNonTag IDs to filter replies by
itemsnumberNonNo description

Sortie

ParamètreTypeDescription
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.

Entrée

ParamètreTypeObligatoireDescription

Sortie

ParamètreTypeDescription
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.

Entrée

ParamètreTypeObligatoireDescription
namestringOuiTag name

Sortie

ParamètreTypeDescription
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.

Entrée

ParamètreTypeObligatoireDescription
tagIdsarrayOuiTag IDs to attach
itemsnumberNonNo description
leadIdsarrayOuiLead IDs to tag
itemsnumberNonNo description
skipWebhooksbooleanNonSkip Email Bison webhooks for this action

Sortie

ParamètreTypeDescription
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