Skip to main content
BlueFox Email logo
  • Category: email
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 11
  • Triggers: 0
  • Slug: BLUEFOX_EMAIL
  • Version: 20261101_00

Tools

Slug: BLUEFOX_EMAIL_CREATE_CONTACTCreate a contact in the specified BlueFox project. This creates persistent project data but does not subscribe the contact to a list.

Input Parameters

object
Custom-property values keyed by the API names configured in the BlueFox project.
string
Contact name.
string
required
Email address for the new contact.
string
required
BlueFox project ID from the project’s settings or a contact Code Guide.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BLUEFOX_EMAIL_DELETE_CONTACTPermanently delete a contact by its current email address from the specified BlueFox project. This is destructive and may affect related email workflows.

Input Parameters

string
required
BlueFox project ID from the project’s settings or a contact Code Guide.
string
required
Current email address of the contact to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BLUEFOX_EMAIL_GET_CONTACTRetrieve one contact by its current email address from the specified BlueFox project.

Input Parameters

string
required
BlueFox project ID from the project’s settings or a contact Code Guide.
string
required
Current email address identifying the contact.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BLUEFOX_EMAIL_GET_SUBSCRIBERRetrieve one subscriber by current email address from a known BlueFox subscriber list.

Input Parameters

string
required
Current email address identifying the subscriber in the list.
string
required
Subscriber-list ID copied from the BlueFox UI. BlueFox does not provide an API endpoint for discovering list IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BLUEFOX_EMAIL_LIST_CONTACTSList contacts in the specified BlueFox project. The tool does not expose filtering or pagination controls.

Input Parameters

string
required
BlueFox project ID from the project’s settings or a contact Code Guide.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BLUEFOX_EMAIL_LIST_SUBSCRIBERSList subscribers in one known BlueFox subscriber list. The tool does not expose filtering or pagination controls.

Input Parameters

string
required
Subscriber-list ID copied from the BlueFox UI. BlueFox does not provide an API for discovering list IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BLUEFOX_EMAIL_SEND_TRANSACTIONAL_EMAILQueue one transactional email for an external recipient. This externally visible action is irreversible and consumes BlueFox send credits; insufficient credits can prevent the send.

Input Parameters

object
Handlebars merge-tag values expected by the selected template.
string
required
External recipient email address. Calling this tool immediately sends an irreversible email and consumes BlueFox send credits.
array
Files to attach. BlueFox publishes no attachment count or size limit; each item must have a filename with an extension and base64 content.
string
required
Transactional template ID copied from the BlueFox Code Guide. BlueFox does not provide an API endpoint for discovering template IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BLUEFOX_EMAIL_SEND_TRIGGERED_EMAILSend a triggered email to one or more specified recipients; only active subscribers on the associated list receive it. This externally visible action is irreversible and consumes BlueFox send credits; insufficient credits can prevent sending.

Input Parameters

object
Handlebars merge-tag values expected by the selected triggered flow.
array
required
Non-empty list of external recipient email addresses. Starting this irreversible flow may send multiple messages over time to every recipient and consumes BlueFox send credits. BlueFox publishes no recipient maximum.
array
Files to attach. Each item accepts canonical file_name or provider-style fileName plus base64 content. BlueFox publishes no attachment count or size limit.
string
required
Triggered email flow ID copied from BlueFox. BlueFox does not provide an API endpoint for discovering flow IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BLUEFOX_EMAIL_SUBSCRIBE_TO_LISTCreate a subscriber-list membership. This changes persistent subscription state and may send a double-opt-in email; setting status to active bypasses double opt-in.

Input Parameters

object
Custom-property values keyed by the API names configured in the BlueFox project.
string
Subscriber name, if known.
string
required
Email address to subscribe to the list.
string
Set to ‘active’ only when intentionally bypassing double opt-in. Omit this field to use the list’s normal opt-in behavior, which may send a confirmation email.
string
required
Subscriber-list ID copied from Manage List > Code Guide. BlueFox does not provide an API endpoint for discovering list IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BLUEFOX_EMAIL_UPDATE_CONTACTUpdate a contact identified by its current email address in the specified BlueFox project. Provide at least one of new_email, name, or data. This changes persistent contact data.

Input Parameters

object
Replacement custom-property values keyed by the API names configured in the BlueFox project. At least one mutable field is required.
string
Replacement contact name. At least one mutable field is required.
string
Replacement email address. Later lookups must use this new address. At least one mutable field is required.
string
required
BlueFox project ID from the project’s settings or a contact Code Guide.
string
required
Current email address identifying the contact.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BLUEFOX_EMAIL_UPDATE_SUBSCRIBERUpdate a subscriber’s identity, custom data, or state in a known BlueFox list. Provide at least one of new_email, name, data, status, or paused_until. This can unsubscribe, pause, or reactivate the subscriber and changes future email eligibility.

Input Parameters

object
Replacement custom-property values keyed by the API names configured in the BlueFox project. At least one mutable field is required.
string
Replacement subscriber name. At least one mutable field is required.
string ("active" | "unsubscribed" | "paused")
New subscription state: ‘active’ re-enables email, ‘unsubscribed’ opts out, and ‘paused’ suppresses email until paused_until. At least one mutable field is required.
string
Replacement email address. Later lookups must use this new address. At least one mutable field is required.
string
Future timezone-aware ISO 8601 date and time until which delivery is paused. Required when status is ‘paused’ and otherwise not allowed. At least one mutable field is required.
string
required
Current email address identifying the subscriber.
string
required
Subscriber-list ID copied from the BlueFox UI. BlueFox does not provide an API endpoint for discovering list IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not