> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/emailoctopus.md).

# EmailOctopus

EmailOctopus manages email marketing lists, contacts and campaigns. Add and update contacts, segment lists with tags, read campaign reports, and enrol contacts into automations from your AI workflows.

### Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector              | Authentication |
| ---------------------- | -------------- |
| EmailOctopus (API Key) | API Key        |

#### EmailOctopus (API Key)

Connect to EmailOctopus to manage email lists, contacts, and campaigns.

**Set up in EmailOctopus**

1. Prepare the EmailOctopus account or service that the workflow will access. Grant access to the required resources and operations.
2. **API Key:** Create a key in EmailOctopus under Developer > API Keys. The key carries full access to the team account; there are no scopes to choose. Legacy v1 keys do not work here and must be regenerated.

**Set up in StackAI**

1. Open **Settings → Connections**, add a connection, and select **EmailOctopus (API Key)**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field | Required | What to enter                                                                                                                                                                                                                                                                     |
| ------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| API Key       | Yes      | Create a key in EmailOctopus under Developer > API Keys. The key carries full access to the team account; there are no scopes to choose. Legacy v1 keys do not work here and must be regenerated. [Provider instructions](https://dashboard.emailoctopus.com/developer/api-keys). |

#### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

### Use an action

1. Add the required **EmailOctopus** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

### Actions

#### Create Contact

Add a new contact to an EmailOctopus list.

**Inputs**

| Field         | Type            | Required | Description                                                                                                                                                         |
| ------------- | --------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| List          | select (string) | Yes      | The list the contact is added to. Options load from the selected connection.                                                                                        |
| Email address | string          | Yes      | The contact's email address.                                                                                                                                        |
| Status        | select (string) | No       | Whether the contact is subscribed straight away, or has to confirm first. Available values: Subscribed, Unsubscribed, Pending (double opt-in). Default: subscribed. |
| Tags          | string          | No       | Comma-separated tags to apply, for segmenting this contact later.                                                                                                   |
| Custom fields | textarea        | No       | Extra field values for this contact, as JSON.                                                                                                                       |

**Outputs**

| Field         | Type     | Description                        |
| ------------- | -------- | ---------------------------------- |
| Contact ID    | string   | The new contact's id.              |
| Email address | string   | The contact's email address.       |
| Status        | string   | The contact's subscription status. |
| Tags          | string   | Tags now on the contact.           |
| Created at    | datetime | When the contact was created.      |

#### Update Contact

Change an existing contact's status, tags, or field values.

**Inputs**

| Field               | Type            | Required | Description                                                                                                          |
| ------------------- | --------------- | -------- | -------------------------------------------------------------------------------------------------------------------- |
| List                | select (string) | Yes      | The list the contact belongs to. Options load from the selected connection.                                          |
| Contact email or ID | string          | Yes      | The email address of the contact to update, or its contact ID.                                                       |
| New email address   | string          | No       | Set a different email address for this contact.                                                                      |
| Status              | select (string) | No       | Change whether this contact receives campaigns. Available values: Subscribed, Unsubscribed, Pending (double opt-in). |
| Tags to add         | string          | No       | Comma-separated tags to attach to this contact.                                                                      |
| Tags to remove      | string          | No       | Comma-separated tags to take off this contact.                                                                       |
| Custom fields       | textarea        | No       | Field values to set, as JSON.                                                                                        |

**Outputs**

| Field           | Type     | Description                                         |
| --------------- | -------- | --------------------------------------------------- |
| Contact ID      | string   | The contact's id.                                   |
| Email address   | string   | The contact's email address after the update.       |
| Status          | string   | The contact's subscription status after the update. |
| Tags            | string   | Tags now on the contact.                            |
| Last updated at | datetime | When the contact was last changed.                  |

#### List Contacts

Get the contacts on a list with one subscription status, optionally filtered by tag or change date.

**Inputs**

| Field            | Type            | Required | Description                                                                                                                                                                                       |
| ---------------- | --------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| List             | select (string) | Yes      | The list to read contacts from. Options load from the selected connection.                                                                                                                        |
| Status           | select (string) | No       | Which contacts to return. EmailOctopus returns one status at a time, so this cannot be left blank to mean every status. Available values: Subscribed, Unsubscribed, Pending. Default: subscribed. |
| Tag              | select (string) | No       | Only return contacts carrying this tag. Options load from the selected connection.                                                                                                                |
| Updated since    | datetime        | No       | Only return contacts changed on or after this time.                                                                                                                                               |
| Created since    | datetime        | No       | Only return contacts added on or after this time.                                                                                                                                                 |
| Maximum contacts | integer         | No       | How many contacts to return at most. Minimum: 1. Default: 100.                                                                                                                                    |
| Cursor           | string          | No       | Continue from a previous run's cursor.                                                                                                                                                            |

**Outputs**

| Field       | Type          | Description                        |
| ----------- | ------------- | ---------------------------------- |
| Contacts    | object\_array | The contacts found.                |
| Next cursor | string        | Pass back in to get the next page. |

#### Get Contact

Look up one contact on a list by email address.

**Inputs**

| Field               | Type            | Required | Description                                                                 |
| ------------------- | --------------- | -------- | --------------------------------------------------------------------------- |
| List                | select (string) | Yes      | The list the contact belongs to. Options load from the selected connection. |
| Contact email or ID | string          | Yes      | The email address to look up, or a contact ID.                              |

**Outputs**

| Field           | Type     | Description                        |
| --------------- | -------- | ---------------------------------- |
| Contact ID      | string   | The contact's id.                  |
| Email address   | string   | The contact's email address.       |
| Status          | string   | The contact's subscription status. |
| Tags            | string   | Tags on the contact.               |
| Custom fields   | dict     | The contact's custom field values. |
| Last updated at | datetime | When the contact was last changed. |

#### Delete Contact

Permanently remove a contact and its history from a list.

**Inputs**

| Field               | Type            | Required | Description                                                                     |
| ------------------- | --------------- | -------- | ------------------------------------------------------------------------------- |
| List                | select (string) | Yes      | The list to remove the contact from. Options load from the selected connection. |
| Contact email or ID | string          | Yes      | The email address of the contact to delete, or its contact ID.                  |

**Outputs**

| Field   | Type    | Description                      |
| ------- | ------- | -------------------------------- |
| Deleted | boolean | Whether the contact was removed. |
| Contact | string  | The contact that was removed.    |

#### Create List

Create a new contact list to hold an audience segment.

**Inputs**

| Field     | Type   | Required | Description            |
| --------- | ------ | -------- | ---------------------- |
| List name | string | Yes      | What to call the list. |

**Outputs**

| Field         | Type     | Description                             |
| ------------- | -------- | --------------------------------------- |
| List ID       | string   | The new list's id.                      |
| List name     | string   | The list's name.                        |
| Double opt-in | boolean  | Whether contacts must confirm by email. |
| Created at    | datetime | When the list was created.              |

#### List Lists

Get the contact lists in the connected EmailOctopus account.

**Inputs**

| Field         | Type    | Required | Description                                                 |
| ------------- | ------- | -------- | ----------------------------------------------------------- |
| Maximum lists | integer | No       | How many lists to return at most. Minimum: 1. Default: 100. |
| Cursor        | string  | No       | Continue from a previous run's cursor.                      |

**Outputs**

| Field       | Type          | Description                        |
| ----------- | ------------- | ---------------------------------- |
| Lists       | object\_array | The lists found.                   |
| Next cursor | string        | Pass back in to get the next page. |

#### List Campaigns

Get the email campaigns in the connected EmailOctopus account.

**Inputs**

| Field             | Type    | Required | Description                                                     |
| ----------------- | ------- | -------- | --------------------------------------------------------------- |
| Maximum campaigns | integer | No       | How many campaigns to return at most. Minimum: 1. Default: 100. |
| Cursor            | string  | No       | Continue from a previous run's cursor.                          |

**Outputs**

| Field       | Type          | Description                        |
| ----------- | ------------- | ---------------------------------- |
| Campaigns   | object\_array | The campaigns found.               |
| Next cursor | string        | Pass back in to get the next page. |

#### Get Campaign Report

Get the performance summary for a sent campaign: opens, clicks, bounces, and unsubscribes.

**Inputs**

| Field    | Type            | Required | Description                                                           |
| -------- | --------------- | -------- | --------------------------------------------------------------------- |
| Campaign | select (string) | Yes      | The campaign to report on. Options load from the selected connection. |

**Outputs**

| Field           | Type    | Description                                          |
| --------------- | ------- | ---------------------------------------------------- |
| Campaign ID     | string  | The campaign reported on.                            |
| Sent            | integer | How many contacts the campaign went to.              |
| Total opens     | integer | How many times it was opened, counting repeats.      |
| Unique opens    | integer | How many distinct contacts opened it.                |
| Total clicks    | integer | How many times a link was clicked, counting repeats. |
| Unique clicks   | integer | How many distinct contacts clicked a link.           |
| Hard bounces    | integer | Permanently undeliverable addresses.                 |
| Soft bounces    | integer | Temporarily undeliverable addresses.                 |
| Unsubscribed    | integer | How many contacts opted out.                         |
| Spam complaints | integer | How many contacts marked it as spam.                 |

#### Add Contact To Automation

Put a contact into an automation so it starts receiving that drip sequence. The automation must use the 'Started via API' trigger.

**Inputs**

| Field               | Type   | Required | Description                                                                                                                                       |
| ------------------- | ------ | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
| Automation ID       | string | Yes      | The automation to enrol the contact into. It must use the 'Started via API' trigger type. Copy the id from the automation's page in EmailOctopus. |
| Contact email or ID | string | Yes      | The email address of the contact to enrol, or its contact ID.                                                                                     |

**Outputs**

| Field   | Type    | Description                                 |
| ------- | ------- | ------------------------------------------- |
| Queued  | boolean | Whether the contact entered the automation. |
| Contact | string  | The contact that was enrolled.              |

### Triggers

A trigger starts a workflow when its configured event occurs. Configure the event and filters before enabling the trigger.

#### New Contact

Starts the workflow when a new contact is added to an EmailOctopus list, for example by signing up through a form.

Pick the EmailOctopus list to watch, and the subscription status to watch for. EmailOctopus reads one status at a time and defaults to 'subscribed', so it cannot be left blank to mean any status; add a second trigger to watch a second status.

**Configuration**

| Field  | Type            | Required | Description                                                                                                                                                                                    |
| ------ | --------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| List   | select (string) | Yes      | The list to watch for new contacts. Options load from the selected connection.                                                                                                                 |
| Status | select (string) | No       | Which contacts to watch. EmailOctopus reads one status at a time, so this cannot be left blank to mean every status. Available values: Subscribed, Unsubscribed, Pending. Default: subscribed. |

**Event inputs**

| Field         | Type     | Required | Description                                                     |
| ------------- | -------- | -------- | --------------------------------------------------------------- |
| Contact ID    | string   | Yes      | The new contact's id. Default: .                                |
| Email address | string   | Yes      | The new contact's email address. Default: .                     |
| Status        | string   | Yes      | The contact's subscription status. Default: .                   |
| Tags          | string   | No       | Tags on the contact.                                            |
| Created at    | datetime | Yes      | When the contact was added. Default: 0001-01-01 00:00:00+00:00. |

**Outputs**

| Field         | Type     | Description                        |
| ------------- | -------- | ---------------------------------- |
| Contact ID    | string   | The new contact's id.              |
| Email address | string   | The new contact's email address.   |
| Status        | string   | The contact's subscription status. |
| Tags          | string   | Tags on the contact.               |
| Created at    | datetime | When the contact was added.        |

#### Contact Updated

Starts the workflow when an existing contact's status, tags, or field values change, for example when someone unsubscribes.

Pick the EmailOctopus list to watch, and the status a contact must reach for the trigger to fire. EmailOctopus reads one status at a time, so it cannot be left blank to mean any change; add a second trigger to watch a second status. Newly created contacts also carry a last\_updated\_at, so this trigger sees additions too; use New Contact instead when only additions matter.

**Configuration**

| Field  | Type            | Required | Description                                                                                                                                                                                                                   |
| ------ | --------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| List   | select (string) | Yes      | The list to watch for contact changes. Options load from the selected connection.                                                                                                                                             |
| Status | select (string) | No       | Which contacts to watch, by the status they now have. EmailOctopus reads one status at a time, so this cannot be left blank to mean every status. Available values: Subscribed, Unsubscribed, Pending. Default: unsubscribed. |

**Event inputs**

| Field           | Type     | Required | Description                                                    |
| --------------- | -------- | -------- | -------------------------------------------------------------- |
| Contact ID      | string   | Yes      | The changed contact's id. Default: .                           |
| Email address   | string   | Yes      | The changed contact's email address. Default: .                |
| Status          | string   | Yes      | The contact's subscription status after the change. Default: . |
| Tags            | string   | No       | Tags on the contact.                                           |
| Last updated at | datetime | Yes      | When the contact changed. Default: 0001-01-01 00:00:00+00:00.  |

**Outputs**

| Field           | Type     | Description                                         |
| --------------- | -------- | --------------------------------------------------- |
| Contact ID      | string   | The changed contact's id.                           |
| Email address   | string   | The changed contact's email address.                |
| Status          | string   | The contact's subscription status after the change. |
| Tags            | string   | Tags on the contact.                                |
| Last updated at | datetime | When the contact changed.                           |

### Important behavior

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/emailoctopus.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
