Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

EmailOctopus Automation API

The Automation API from EmailOctopus — 1 operation(s) for automation.

EmailOctopus Automation API is one of 6 APIs that EmailOctopus publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Automation. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 1 operation across 1 path. It is described by OpenAPI 3.0.1, at version 2.0.

Requests are made against a single base URL, https://api.emailoctopus.com.

1 operations 1 paths 0 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
2.0
Base URL
https://api.emailoctopus.com
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

EmailOctopus Automation API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (api_key). By default, every request must be authenticated.

  • api_key — Bearer API key in the Authorization header. Create a key at https://api.emailoctopus.com/developer/api-keys/create

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

Automation 1
POST
/automations/{automation_id}/queue
Start an automation for a contact
startAutomation 1 param body → 202

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

emailoctopus-automation-api-openapi.yml Raw ↑

Other APIs EmailOctopus publishes across the network.

EmailOctopus Campaign API
EmailOctopus Contact API
EmailOctopus Field API
EmailOctopus List API
EmailOctopus Tag API