---
canonical_url: "https://docs.composio.dev/toolkits/bluefox_email"
markdown_url: "https://docs.composio.dev/toolkits/bluefox_email.md"
product: "platform"
version: null
last_updated: null
---

# BlueFox Email

BlueFox Email provides APIs for managing contacts and subscriber lists and sending transactional and triggered emails.

- **Category:** email
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 11
- **Triggers:** 0
- **Slug:** `BLUEFOX_EMAIL`
- **Version:** 00000000_00

## Tools

### Create Contact

**Slug:** `BLUEFOX_EMAIL_CREATE_CONTACT`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | No | Custom-property values keyed by the API names configured in the BlueFox project. |
| `name` | string | No | Contact name. |
| `email` | string | Yes | Email address for the new contact. |
| `project_id` | string | Yes | BlueFox project ID from the project's settings or a contact Code Guide. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Contact

**Slug:** `BLUEFOX_EMAIL_DELETE_CONTACT`

Permanently delete a contact by its current email address from the specified BlueFox project. This is destructive and may affect related email workflows.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | BlueFox project ID from the project's settings or a contact Code Guide. |
| `contact_email` | string | Yes | Current email address of the contact to permanently delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Contact

**Slug:** `BLUEFOX_EMAIL_GET_CONTACT`

Retrieve one contact by its current email address from the specified BlueFox project.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | BlueFox project ID from the project's settings or a contact Code Guide. |
| `contact_email` | string | Yes | Current email address identifying the contact. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Subscriber

**Slug:** `BLUEFOX_EMAIL_GET_SUBSCRIBER`

Retrieve one subscriber by current email address from a known BlueFox subscriber list.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `subscriber_email` | string | Yes | Current email address identifying the subscriber in the list. |
| `subscriber_list_id` | string | Yes | Subscriber-list ID copied from the BlueFox UI. BlueFox does not provide an API endpoint for discovering list IDs. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Contacts

**Slug:** `BLUEFOX_EMAIL_LIST_CONTACTS`

Return all contacts in the specified BlueFox project. BlueFox documents no filters or pagination parameters.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | BlueFox project ID from the project's settings or a contact Code Guide. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Subscribers

**Slug:** `BLUEFOX_EMAIL_LIST_SUBSCRIBERS`

Return subscribers in one known BlueFox subscriber list. BlueFox documents no filters or pagination parameters.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `subscriber_list_id` | string | Yes | Subscriber-list ID copied from the BlueFox UI. BlueFox does not provide an API for discovering list IDs. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Send Transactional Email

**Slug:** `BLUEFOX_EMAIL_SEND_TRANSACTIONAL_EMAIL`

Immediately send one transactional-template email to an external recipient. This externally visible action is irreversible and consumes BlueFox send credits. Insufficient credits or a bounce-flagged recipient can prevent the send.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Send Triggered Email

**Slug:** `BLUEFOX_EMAIL_SEND_TRIGGERED_EMAIL`

Start a triggered email flow for one or more external recipients. This externally visible action is irreversible, may send multiple messages over time, and consumes BlueFox send credits. Insufficient credits can prevent the flow from starting.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | No | Handlebars merge-tag values expected by the selected triggered flow. |
| `emails` | array | Yes | 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. |
| `attachments` | array | No | Files to attach. Each item accepts canonical file_name or provider-style fileName plus base64 content. BlueFox publishes no attachment count or size limit. |
| `triggered_id` | string | Yes | Triggered email flow ID copied from BlueFox. BlueFox does not provide an API endpoint for discovering flow IDs. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Subscribe To List

**Slug:** `BLUEFOX_EMAIL_SUBSCRIBE_TO_LIST`

Create 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | No | Custom-property values keyed by the API names configured in the BlueFox project. |
| `name` | string | No | Subscriber name, if known. |
| `email` | string | Yes | Email address to subscribe to the list. |
| `status` | string | No | 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. |
| `subscriber_list_id` | string | Yes | Subscriber-list ID copied from Manage List > Code Guide. BlueFox does not provide an API endpoint for discovering list IDs. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Contact

**Slug:** `BLUEFOX_EMAIL_UPDATE_CONTACT`

Update 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | No | Replacement custom-property values keyed by the API names configured in the BlueFox project. At least one mutable field is required. |
| `name` | string | No | Replacement contact name. At least one mutable field is required. |
| `new_email` | string | No | Replacement email address. Later lookups must use this new address. At least one mutable field is required. |
| `project_id` | string | Yes | BlueFox project ID from the project's settings or a contact Code Guide. |
| `contact_email` | string | Yes | Current email address identifying the contact. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Subscriber

**Slug:** `BLUEFOX_EMAIL_UPDATE_SUBSCRIBER`

Update 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | No | Replacement custom-property values keyed by the API names configured in the BlueFox project. At least one mutable field is required. |
| `name` | string | No | Replacement subscriber name. At least one mutable field is required. |
| `status` | string ("active" | "unsubscribed" | "paused") | No | New subscription state: 'active' re-enables email, 'unsubscribed' opts out, and 'paused' suppresses email until paused_until. At least one mutable field is required. |
| `new_email` | string | No | Replacement email address. Later lookups must use this new address. At least one mutable field is required. |
| `paused_until` | string | No | 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. |
| `subscriber_email` | string | Yes | Current email address identifying the subscriber. |
| `subscriber_list_id` | string | Yes | Subscriber-list ID copied from the BlueFox UI. BlueFox does not provide an API endpoint for discovering list IDs. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |