EmailOctopus API

Name: EmailOctopus API
Brand: EmailOctopus API
Availability: InStock

★ Only Publicly Available OpenAPI DocumentMarketingEmail MarketingapiKey25 EndpointsREST

For Agents

Manage EmailOctopus lists, contacts, tags, campaigns, and per-campaign reports for email-marketing workflows. Authenticated with an API key.

Install Jentic One Beta

Connect the EmailOctopus API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the EmailOctopus API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.

Step 1: Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with EmailOctopus API.

Manage subscriber lists with full CRUD via /api/2.0/lists

Add, update, and delete contacts within a list including tag and field assignments

Read campaign reports broken out by openers, clickers, bouncers, and complainers

GET STARTED

Start building with EmailOctopus API

Explore with Jentic

View OpenAPI Document

Use Cases

Patterns agents use EmailOctopus API for, with concrete tasks.

★ List Growth and Subscriber Sync

Sync subscribers from a website signup form, CRM, or e-commerce platform into EmailOctopus by calling POST /api/2.0/lists/{listId}/contacts. The same endpoint group supports updating custom fields, applying tags, and removing contacts on unsubscribe. Suitable for lists ranging from a few hundred to several hundred thousand subscribers.

POST a contact to /api/2.0/lists/{listId}/contacts with email, first_name, and a 'newsletter' tag, then GET the contact to confirm it was created

Campaign Performance Reporting

Build a marketing dashboard that pulls per-campaign open, click, bounce, and complaint counts from /api/2.0/campaigns/{campaignId}/reports/summary and the related per-cohort endpoints (clicked, opened, bounced, complained, unsubscribed). The breakouts let a dashboard render lists of who specifically engaged or failed, not just aggregates.

Fetch the report summary for campaign_id=abc123, then list the clicked-contacts via GET /api/2.0/campaigns/{campaignId}/reports/clicked for follow-up outreach

Audience Segmentation by Tag

Segment a list by tag using /api/2.0/lists/{listId}/tags and /api/2.0/lists/{listId}/tags/{tag} to find audience subsets for targeted sends. Combine with /api/2.0/lists/{listId}/contacts to read full contact records for the chosen tag and feed a campaign-creation flow with the right recipients.

List tags on list_id=xyz, fetch the 'product-launch-interest' tag membership, and create a new campaign targeting only those contacts

AI Agent Integration via Jentic

Build an AI marketing agent that drafts a campaign from a content brief, creates the campaign in EmailOctopus, and after the send pulls the report summary to write a results memo. Through Jentic, the agent searches by intent, loads the campaign-create schema, and executes without holding the API key in its prompt.

Search Jentic for 'create an EmailOctopus campaign', load the schema for POST /api/2.0/campaigns, and create a campaign from the latest content brief

Key Endpoints

25 endpoints — jentic publishes the only available openapi specification for emailoctopus api, keeping it validated and agent-ready.

METHOD

PATH

DESCRIPTION

GET

/api/2.0/lists

Get all lists

POST

/api/2.0/lists/{listId}/contacts

Add a contact to a list

GET

/api/2.0/lists/{listId}/tags

Get tags for a list

POST

/api/2.0/campaigns

Create a campaign

GET

/api/2.0/campaigns/{campaignId}/reports/summary

Get campaign report summary

GET

/api/2.0/campaigns/{campaignId}/reports/clicked

Get contacts who clicked a campaign link

GET

/api/2.0/automations

List automations

GET

/api/2.0/lists

Get all lists

POST

/api/2.0/lists/{listId}/contacts

Add a contact to a list

GET

/api/2.0/lists/{listId}/tags

Get tags for a list

POST

/api/2.0/campaigns

Create a campaign

GET

/api/2.0/campaigns/{campaignId}/reports/summary

Get campaign report summary

Why Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

The EmailOctopus API key is stored encrypted in the Jentic vault (MAXsystem) and injected at execution time. Agents never hold the raw key in prompts or memory.

Intent-based discovery

Agents search by intent (e.g. 'create a campaign' or 'who clicked the campaign') and Jentic returns the matching EmailOctopus operation with its input schema, so the agent picks the right endpoint without parsing the upstream docs.

Time to first call

Direct integration: 1-2 days to wire auth, paginate through lists, and assemble a reporting view. Through Jentic: under 30 minutes — search, load schema, execute.

FAQs

Specific to using EmailOctopus API through Jentic.

Why is there no official OpenAPI spec for EmailOctopus API?

EmailOctopus publishes its API reference as HTML at emailoctopus.com/api-documentation/v2 rather than as a versioned OpenAPI specification. Jentic generates and maintains this spec so AI agents and developers can call EmailOctopus via structured tooling. It is validated against the live API and kept up to date. Get started at https://app.jentic.com/sign-up.

What authentication does the EmailOctopus API use?

EmailOctopus v2 uses an API key issued from the dashboard. Through Jentic, the key is stored encrypted in the vault and injected at execution time so the agent never sees the raw key in its prompt or logs.

Can I see who clicked a specific campaign link?

Yes. GET /api/2.0/campaigns/{campaignId}/reports/clicked returns the contacts who clicked at least one link in the campaign. The same campaign-reports group exposes opened, bounced, complained, sent, and unsubscribed cohorts as separate endpoints.

How do I tag a contact?

Apply tags by including a tags array on the contact when calling POST /api/2.0/lists/{listId}/contacts or PUT /api/2.0/lists/{listId}/contacts/{contactId}. Read tag membership for a list with GET /api/2.0/lists/{listId}/tags and GET /api/2.0/lists/{listId}/tags/{tag}.

How do I create a campaign through EmailOctopus via Jentic?

Run the Jentic search query 'create an EmailOctopus campaign', load the input schema for POST /api/2.0/campaigns, then execute with the campaign name, subject, content, and target list ID. Jentic injects the API key at execution time.

Does the EmailOctopus API expose automations?

Yes, but read-only. GET /api/2.0/automations lists configured automations and GET /api/2.0/automations/{automationId} fetches a single automation. Authoring and editing automations is currently a dashboard-only operation.

EmailOctopus API

Connect the EmailOctopus API to your agent

Capabilities

Start building with EmailOctopus API

Use Cases

Key Endpoints

Why Jentic?

Related APIs

FAQs