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 Field API

The Field API from EmailOctopus — 2 operation(s) for field.

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

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

This API exposes 3 operations across 2 paths, and defines 1 schema. It is described by OpenAPI 3.0.1, at version 2.0.

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

3 operations 2 paths 1 schemas 1 DELETE1 POST1 PUT

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 Field 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 3

Across 2 paths, the API surfaces 3 operations — 1 DELETE, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Field 3
POST
/lists/{list_id}/fields
Create field
createField 1 param body → 200
PUT
/lists/{list_id}/fields/{tag}
Update field
updateField 2 params body → 200
DELETE
/lists/{list_id}/fields/{tag}
Delete field
deleteField 2 params → 204

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is Field (5 properties). Each schema is shown below with its type and property counts.

Field
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

emailoctopus-field-api-openapi.yml Raw ↑

Other APIs EmailOctopus publishes across the network.

EmailOctopus Automation API
EmailOctopus Campaign API
EmailOctopus Contact API
EmailOctopus List API
EmailOctopus Tag API