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 Make, 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.

Note

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

Connecting EmailOctopus to Make

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

  1. Log in to your EmailOctopus account.

  2. Click your Profile Icon > Integrations & API > Developers API > Create a Key.

    61f26bee25c80.gif
  3. Copy the API Key to your clipboard.

    61f26bf0bc884.png
  4. Go to Make and open the EmailOctopus module's Create a connection dialog.

    61f26bf1d7e8b.gif
  5. In the Connection name field, enter a name for the connection.

  6. In the API Key field, enter the API key copied in step 3 and click Continue.

The connection has been established.

Campaigns

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.

Gets details of all campaigns.

Connection

Establish a connection to your EmailOctopus account.

Limit

Enter the maximum number of campaigns Make should return during one scenario execution cycle.

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

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.

Get details of all the lists.

Connection

Establish a connection to your EmailOctopus account.

Limit

Enter the maximum number of lists Make should return during one scenario execution cycle.

Creates a new list.

Connection

Establish a connection to your EmailOctopus account.

List Name

Enter a name for the 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.

Deletes a list.

Connection

Establish a connection to your EmailOctopus account.

List ID

Select the List ID you want to delete.

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.

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 Make should return during one scenario execution cycle.

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

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

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

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

Note

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.

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

URL:

/1.5/lists

Method:

GET

61f26bf42dbc6.png

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

In our example, 3 lists were returned:

61f26bf579afd.png