BlueFox Email API Documentation
This is the complete API documentation for connecting to the BlueFox Email API using MindCloud's Universal API. If you are new to MindCloud, start with the Introduction to see how one API can sit in front of many different apps.
MindCloud is an integration company that offers one normalized API to access 3,100+ apps from a single place. It cleans up provider-specific quirks, keeps requests and responses consistent, and centralizes authentication so you do not need to manage separate flows for every app. Browse other apps.
Meet BlueFox Email: Send transactional, triggered, and campaign emails and manage contacts. Keep reading to get started.
Quickstart
Before you run your first BlueFox Email request, you need three things:
- A MindCloud account — sign in or create an account at MindCloud.
- A MindCloud API Key — create one in API Keys. Keep it on your server.
- At least one BlueFox Email connection — create or choose one in Connections. Note its
connectionId.
Every BlueFox Email action uses the same URL pattern:
https://connect.mindcloud.co/v1/universal/blueFoxEmail/latest/actions/{actionSlug}You need a MindCloud API Key and a BlueFox Email connection. Then call an action such as Get Contact:
curl --request GET \
--url "https://connect.mindcloud.co/v1/universal/blueFoxEmail/latest/actions/get-contact" \
--header "Authorization: Bearer $MINDCLOUD_API_KEY" \
--get \
--data-urlencode "connectionId=$CONNECTION_ID"Every response comes back in the same envelope, with your rows in a data array:
{
"success": true,
"data": [
{ "id": "1042", "name": "Ava" }
],
"meta": {}
}After your first request works, use Shape your requests to control arguments, pagination, filtering, fields, and errors.
Authentication
Authentication has two layers. Your MindCloud API Key authenticates the request to MindCloud, sent as a Bearer token in the Authorization header. The connectionId selects the connected BlueFox Email account that should run the action. MindCloud stores and refreshes the BlueFox Email credentials behind that connection, so you never send provider tokens with your requests.
Pass connectionId in the query string for GET and DELETE actions, and in the JSON body for POST, PUT, and PATCH actions. Keep your MindCloud API Key on your server; do not ship it in browser code, mobile apps, public repositories, or logs.
BlueFox Email actions
All 14 published actions for this BlueFox Email version. Each page documents the endpoint, arguments, and response controls.
- PUTActivate Subscription
- POSTCreate Contact
- DELETEDelete Contact
- GETGet Contact
- GETGet Subscriber
- GETList Contacts
- GETList Subscribers
- PUTPause Subscription
- POSTSend Transactional Email
- POSTSend Triggered Email
- POSTSubscribe
- PUTUnsubscribe
- PUTUpdate Contact
- PUTUpdate Subscriber
Related apps
More Marketing apps on the Universal API, behind the same REST shape. Or browse all apps.