Skip to main content

​
Overview

To authenticate with EmailOctopus, you need:
  1. API Key — an EmailOctopus API key.
This guide will show you how to get it.

​
Prerequisites

  • An EmailOctopus account. The API is available on every plan, the free one included. You can sign up if you don’t have one.

​
Step 1: Create an API key

  1. Sign in to the EmailOctopus dashboard.
  2. Go to Account -> Integrations & API -> API keys (direct link), then click Add a key.
EmailOctopus API page with the Add a key button next to Your keys
  1. Enter a name for the key in the Key name field, then click Create.
EmailOctopus Create API key page with the Key name field and the Create button
  1. In the Your API key dialog, click Copy (or Download to save it as a CSV file). The key is shown only once.
EmailOctopus Your API key dialog with the Download and Copy buttons
If your existing key is labelled legacy, it was created before API v2. Create a new key instead.

​
Step 2: Enter your API key in the Connect UI

  1. Open the form where you need to authenticate with EmailOctopus.
  2. Enter your API key in the API Key field.
  3. Submit the form, and you should be successfully authenticated.
EmailOctopus Connect UI form with the API Key field You are now connected to EmailOctopus.