Email Bison

Usage Instructions

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

Tools

`emailbison_list_leads`

Input

Parameter	Type	Required	Description
`search`	string	No	No description
`campaignStatus`	string	No	No description
`tagIds`	array	No	No description
`items`	number	No	No description
`excludedTagIds`	array	No	No description
`items`	number	No	No description
`withoutTags`	boolean	No	No description

Output

Parameter	Type	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

`emailbison_get_lead`

Input

Parameter	Type	Required	Description
`leadId`	string	Yes	No description

Output

Parameter	Type	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

`emailbison_create_lead`

Input

Parameter	Type	Required	Description
`firstName`	string	Yes	No description
`lastName`	string	Yes	No description
`email`	string	Yes	No description
`title`	string	No	No description
`company`	string	No	No description
`notes`	string	No	No description
`customVariables`	array	No	No description
`items`	object	No	No description
`properties`	string	No	No description
`name`	string	No	No description
`value`	string	No	No description

Output

Parameter	Type	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

`emailbison_update_lead`

Input

Parameter	Type	Required	Description
`leadId`	string	Yes	No description
`firstName`	string	Yes	No description
`lastName`	string	Yes	No description
`email`	string	Yes	No description
`title`	string	No	No description
`company`	string	No	No description
`notes`	string	No	No description
`customVariables`	array	No	No description
`items`	object	No	No description
`properties`	string	No	No description
`name`	string	No	No description
`value`	string	No	No description

Output

Parameter	Type	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

`emailbison_list_campaigns`

Input

Parameter	Type	Required	Description

Output

Parameter	Type	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

`emailbison_create_campaign`

Input

Parameter	Type	Required	Description
`name`	string	Yes	No description
`campaignType`	string	No	No description

Output

Parameter	Type	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

`emailbison_update_campaign`

Input

Parameter	Type	Required	Description
`campaignId`	number	Yes	No description
`name`	string	No	No description
`maxEmailsPerDay`	number	No	No description
`maxNewLeadsPerDay`	number	No	No description
`plainText`	boolean	No	No description
`openTracking`	boolean	No	No description
`reputationBuilding`	boolean	No	No description
`canUnsubscribe`	boolean	No	No description
`includeAutoRepliesInStats`	boolean	No	No description
`sequencePrioritization`	string	No	No description

Output

Parameter	Type	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

`emailbison_update_campaign_status`

Input

Parameter	Type	Required	Description
`campaignId`	number	Yes	No description
`action`	string	Yes	No description

Output

Parameter	Type	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

`emailbison_attach_leads_to_campaign`

Input

Parameter	Type	Required	Description
`campaignId`	number	Yes	No description
`leadIds`	array	Yes	No description
`items`	number	No	No description
`allowParallelSending`	boolean	No	No description

Output

Parameter	Type	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

`emailbison_list_replies`

Input

Parameter	Type	Required	Description
`search`	string	No	No description
`status`	string	No	No description
`folder`	string	No	No description
`read`	boolean	No	No description
`campaignId`	number	No	No description
`senderEmailId`	number	No	No description
`leadId`	number	No	No description
`tagIds`	array	No	No description
`items`	number	No	No description

Output

Parameter	Type	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

`emailbison_list_tags`

Input

Parameter	Type	Required	Description

Output

Parameter	Type	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

`emailbison_create_tag`

Input

Parameter	Type	Required	Description
`name`	string	Yes	No description

Output

Parameter	Type	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

`emailbison_attach_tags_to_leads`

Input

Parameter	Type	Required	Description
`tagIds`	array	Yes	No description
`items`	number	No	No description
`leadIds`	array	Yes	No description
`items`	number	No	No description
`skipWebhooks`	boolean	No	No description

Output

Parameter	Type	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

Email Bison

このページについて