AptlyStar

Email Bison

Manage Email Bison leads, campaigns, replies, and tags

Instrucciones de uso

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

Herramientas

emailbison_list_leads

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

Entrada

ParámetroTipoObligatorioDescripción
searchstringNoSearch term for filtering leads
campaignStatusstringNoLead campaign status filter: in_sequence, sequence_finished, sequence_stopped, never_contacted, or replied
tagIdsarrayNoTag IDs to include
itemsnumberNoNo description
excludedTagIdsarrayNoTag IDs to exclude
itemsnumberNoNo description
withoutTagsbooleanNoOnly return leads without tags

Salida

ParámetroTipoDescripción
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.

Entrada

ParámetroTipoObligatorioDescripción
leadIdstringSíLead ID or email address

Salida

ParámetroTipoDescripción
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.

Entrada

ParámetroTipoObligatorioDescripción
firstNamestringSíLead first name
lastNamestringSíLead last name
emailstringSíLead email address
titlestringNoLead job title
companystringNoLead company
notesstringNoAdditional notes about the lead
customVariablesarrayNoCustom variables to store on the lead
itemsobjectNoCustom variable name
propertiesstringNoCustom variable name
namestringNoNo description
valuestringNoNo description

Salida

ParámetroTipoDescripción
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.

Entrada

ParámetroTipoObligatorioDescripción
leadIdstringSíLead ID or email address
firstNamestringSíLead first name
lastNamestringSíLead last name
emailstringSíLead email address
titlestringNoLead job title
companystringNoLead company
notesstringNoAdditional notes about the lead
customVariablesarrayNoCustom variables to store on the lead
itemsobjectNoCustom variable name
propertiesstringNoCustom variable name
namestringNoNo description
valuestringNoNo description

Salida

ParámetroTipoDescripción
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.

Entrada

ParámetroTipoObligatorioDescripción

Salida

ParámetroTipoDescripción
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.

Entrada

ParámetroTipoObligatorioDescripción
namestringSíCampaign name
campaignTypestringNoCampaign type: outbound or reply_followup

Salida

ParámetroTipoDescripción
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.

Entrada

ParámetroTipoObligatorioDescripción
campaignIdnumberSíCampaign ID
namestringNoCampaign name
maxEmailsPerDaynumberNoMaximum emails per day
maxNewLeadsPerDaynumberNoMaximum new leads per day
plainTextbooleanNoSend plain text emails
openTrackingbooleanNoEnable open tracking
reputationBuildingbooleanNoEnable reputation building
canUnsubscribebooleanNoEnable unsubscribe link
includeAutoRepliesInStatsbooleanNoInclude auto replies in campaign stats
sequencePrioritizationstringNoSequence prioritization: followups or new_leads

Salida

ParámetroTipoDescripción
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.

Entrada

ParámetroTipoObligatorioDescripción
campaignIdnumberSíCampaign ID
actionstringSíStatus action: pause, resume, or archive

Salida

ParámetroTipoDescripción
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.

Entrada

ParámetroTipoObligatorioDescripción
campaignIdnumberSíCampaign ID
leadIdsarraySíLead IDs to add to the campaign
itemsnumberNoNo description
allowParallelSendingbooleanNoForce add leads already in sequence in other campaigns

Salida

ParámetroTipoDescripción
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.

Entrada

ParámetroTipoObligatorioDescripción
searchstringNoSearch term for replies
statusstringNoReply status: interested, automated_reply, or not_automated_reply
folderstringNoReply folder: inbox, sent, spam, bounced, or all
readbooleanNoFilter by read state
campaignIdnumberNoCampaign ID
senderEmailIdnumberNoSender email ID
leadIdnumberNoLead ID
tagIdsarrayNoTag IDs to filter replies by
itemsnumberNoNo description

Salida

ParámetroTipoDescripción
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.

Entrada

ParámetroTipoObligatorioDescripción

Salida

ParámetroTipoDescripción
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.

Entrada

ParámetroTipoObligatorioDescripción
namestringSíTag name

Salida

ParámetroTipoDescripción
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.

Entrada

ParámetroTipoObligatorioDescripción
tagIdsarraySíTag IDs to attach
itemsnumberNoNo description
leadIdsarraySíLead IDs to tag
itemsnumberNoNo description
skipWebhooksbooleanNoSkip Email Bison webhooks for this action

Salida

ParámetroTipoDescripción
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