EmailOctopus API Documentation

This is the complete API documentation for connecting to the EmailOctopus 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 EmailOctopus: Manage email lists, contacts, and campaigns in EmailOctopus. Keep reading to get started.

Quickstart

Before you run your first EmailOctopus request, you need three things:

1. A MindCloud account — sign in or create an account at MindCloud.
2. A MindCloud API Key — create one in API Keys. Keep it on your server.
3. At least one EmailOctopus connection — create or choose one in Connections. Note its connectionId.

Every EmailOctopus action uses the same URL pattern:

POST https://connect.mindcloud.co/v2/universal/apps/emailOctopus/actions/{actionSlug}/run

You need a MindCloud API Key and a EmailOctopus connection. Then call an action such as List Lists:

curl --request POST \
  --url "https://connect.mindcloud.co/v2/universal/apps/emailOctopus/actions/list-lists/run" \
  --header "Authorization: Bearer $MINDCLOUD_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
  "connectionId": "$CONNECTION_ID",
  "arguments": {}
}'

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.

Authenticate with a MindCloud API Key plus a connectionId for your EmailOctopus account. See EmailOctopus API Authentication for the full flow and how to get your connection credentials.

EmailOctopus actions

All 24 published actions for this EmailOctopus version. Each page documents the endpoint, arguments, and response controls.

• POSTCreate Contact
• POSTCreate List
• DELETEDelete Contact
• DELETEDelete List
• GETGet Campaign
• GETGet Campaign Report: Bounced
• GETGet Campaign Report: Clicked
• GETGet Campaign Report: Links
• GETGet Campaign Report: Not Clicked
• GETGet Campaign Report: Opened
• GETGet Campaign Report: Sent
• GETGet Campaign Report: Summary
• GETGet Campaign Report: Unsubscribed
• GETGet Contact
• GETGet List
• GETList Campaigns
• GETList Contacts
• GETList Contacts by Tag
• GETList Lists
• GETList Subscribed Contacts
• GETList Unsubscribed Contacts
• PUTUpdate Contact
• PUTUpdate List
• PUTUpdate Multiple Contacts

Related apps

More Communication apps on the Universal API, behind the same REST shape. Or browse all apps.

GmailSlackDiscordTwilioMicrosoft TeamsCircletl;dvClickSend SMS