EmailOctopus

The EmailOctopus modules allow you to create, update, retrieve, and delete the campaigns, and lists in your EmailOctopus account.

Getting Started with EmailOctopus

Prerequisites

An EmailOctopus account

In order to use EmailOctopus with Boost.space Integrator, it is necessary to have an EmailOctopus account. If you do not have one, you can create an EmailOctopus account at emailoctopus.com/account/sign-up.

The module dialog fields that are displayed in bold (in the Boost.space Integrator scenario, not in this documentation article) are mandatory!

Connecting EmailOctopus to Boost.space Integrator

To connect your EmailOctopus account to Boost.space Integrator you need to obtain the API Key from your EmailOctopus account and insert it in the Create a connection dialog in the Boost.space Integrator module.

Log in to your EmailOctopus account.
Click your Profile Icon > Integrations & API> Developers API > Create a Key.
Copy the API Key to your clipboard.
Go to Boost.space Integrator and open the EmailOctopus module’s Create a connection dialog.
In the Connection name field, enter a name for the connection.
In the API Key field, enter the API key copied in step 3 and click Continue.

The connection has been established.

Campaigns

Get a Campaign

Gets details of a campaign.

Connection

Establish a connection to your EmailOctopus account.

Campaign ID

Select the Campaign ID whose details you want to retrieve.

Get Campaigns

Gets details of all campaigns.

Connection

Establish a connection to your EmailOctopus account.

Limit

Enter the maximum number of campaigns Boost.space Integrator should return during one scenario execution cycle.

Get Campaign Report: Summary

Gets a summary of the campaign.

Connection

Establish a connection to your EmailOctopus account.

Campaign ID

Select the Campaign ID whose report summary you want to retrieve.

Lists

Get a List

Gets details of a list.

Connection

Establish a connection to your EmailOctopus account.

List ID

Select the List ID whose details you want to retrieve.

List All Lists

Get details of all the lists.

Connection

Establish a connection to your EmailOctopus account.

Limit

Enter the maximum number of lists Boost.space Integrator should return during one scenario execution cycle.

Create a List

Creates a new list.

Connection

Establish a connection to your EmailOctopus account.

List Name

Enter a name for the list.

Update a List

Updates a list.

Connection

Establish a connection to your EmailOctopus account.

List ID

Select the List ID whose details you want to update.

List Name

Enter a name for the list.

Delete a List

Deletes a list.

Connection

Establish a connection to your EmailOctopus account.

List ID

Select the List ID you want to delete.

Get a Contact from a List

Gets details of a contact of a list.

Connection

Establish a connection to your EmailOctopus account.

List ID

Select the List ID from which you want to retrieve the details of a contact.

Get Contacts from a List

Gets details of all contacts of a list.

Connection

Establish a connection to your EmailOctopus account.

List ID

Select the List ID who contacts details you want to retrieve.

Category

Select the category of the contacts:

All
Subscribed
Unsubscribed

Limit

Enter the maximum number of contacts Boost.space Integrator should return during one scenario execution cycle.

Create a Contact in a List

Creates a contact of a list.

Connection

Establish a connection to your EmailOctopus account.

List ID

Select the List ID in which you want to create a contact.

First Name

Enter the first name of the contact.

Last Name

Enter the last name of the contact.

Email Address

Enter the email address of the contact.

Status

Select the status of the contact:

Subscribed
Unsubscribed
Pending

Update a Contact in a List

Updates contact of a list.

Connection

Establish a connection to your EmailOctopus account.

List ID

Select the List ID whose contact details you want to update.

Member ID

Select the contact’s Member ID whose details you want to update.

First Name

Enter the first name of the contact.

Last Name

Enter the last name of the contact.

Email Address

Enter the email address of the contact.

Status

Select the status of the contact:

Subscribed
Unsubscribed
Pending

Delete a Contact from a List

Deletes a contact of a list.

Connection

Establish a connection to your EmailOctopus account.

List ID

Select the List ID whose contact you want to delete.

Member ID

Select the contact’s Member ID you want to delete.

Other

Make an API Call

Performs an arbitrary authorized API call.

Connection

Establish a connection to your EmailOctopus account.

URL

Enter a path relative to https://emailoctopus.com/api. For example: /1.5/campaigns

For the list of available endpoints, refer to the EmailOctopus API Documentation.

Method

Select the HTTP method you want to use:

GET

to retrieve information for an entry

POST

to create a new entry.

PUT

to update/replace an existing entry.

PATCH

to make a partial entry update.

DELETE

to delete an entry.

Headers

Enter the desired request headers. You don’t have to add authorization headers; we already did that for you.

Query String

Enter the request query string.

Body

Enter the body content for your API call.

Example of Use – Get Lists

The following API call returns all the lists from your EmailOctopus account:

URL:

/1.5/lists

Method:

GET

Matches of the search can be found in the module’s Output under Bundle > Body > data.

In our example, 3 lists were returned:

Legacy article, imported from the original Boost.space knowledge base (/knowledge-base/applications/marketing/emailoctopus/).

Elastic Email

Emercury