# EmailOctopus API Documentation

This is the complete API documentation for connecting to the EmailOctopus API using MindCloud's Universal API.

MindCloud offers one normalized API to access 3,400+ apps from a single place. It centralizes authentication and normalizes app APIs so they are easier and more consistent to use.

## Quickstart

1. A **MindCloud account** — sign in or create an account at [MindCloud](https://app.mindcloud.co).
2. A **MindCloud API Key** — create one in [API Keys](https://app.mindcloud.co/user/api-keys). Keep it on your server.
3. At least one **EmailOctopus connection** — create or choose one in [Connections](https://app.mindcloud.co/credentials). Note its `connectionId`.

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

## EmailOctopus actions

- POST `create-contact` Create Contact
- POST `create-list` Create List
- DELETE `delete-contact` Delete Contact
- DELETE `delete-list` Delete List
- GET `get-campaign` Get Campaign
- GET `get-campaign-report-bounced` Get Campaign Report: Bounced
- GET `get-campaign-report-clicked` Get Campaign Report: Clicked
- GET `get-campaign-report-links` Get Campaign Report: Links
- GET `get-campaign-report-not-clicked` Get Campaign Report: Not Clicked
- GET `get-campaign-report-opened` Get Campaign Report: Opened
- GET `get-campaign-report-sent` Get Campaign Report: Sent
- GET `get-campaign-report-summary` Get Campaign Report: Summary
- GET `get-campaign-report-unsubscribed` Get Campaign Report: Unsubscribed
- GET `get-contact` Get Contact
- GET `get-list` Get List
- GET `list-campaigns` List Campaigns
- GET `list-contacts` List Contacts
- GET `list-contacts-by-tag` List Contacts by Tag
- GET `list-lists` List Lists
- GET `list-subscribed-contacts` List Subscribed Contacts
- GET `list-unsubscribed-contacts` List Unsubscribed Contacts
- PUT `update-contact` Update Contact
- PUT `update-list` Update List
- PUT `update-multiple-contacts` Update Multiple Contacts