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

The Tag API from EmailOctopus — 2 operation(s) for tag.

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

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

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

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

4 operations 2 paths 3 schemas 1 DELETE1 GET1 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 Tag 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 4

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

Tag 4
GET
/lists/{list_id}/tags
Get all tags
getAllTags 3 params → 200
POST
/lists/{list_id}/tags
Create tag
createTag 1 param body → 200
PUT
/lists/{list_id}/tags/{tag}
Update tag
updateTag 2 params body → 200
DELETE
/lists/{list_id}/tags/{tag}
Delete tag
deleteTag 2 params → 204

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are Paging (2 properties), TagCollection (2 properties), Tag (1 property). Each schema is shown below with its type and property counts.

Tag
object
1 property
TagCollection
object
2 properties
Paging
object
Cursor pagination metadata.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

emailoctopus-tag-api-openapi.yml Raw ↑

Other APIs EmailOctopus publishes across the network.

EmailOctopus Automation API
EmailOctopus Campaign API
EmailOctopus Contact API
EmailOctopus Field API
EmailOctopus List API