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

The Contact API from EmailOctopus — 3 operation(s) for contact.

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

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

This API exposes 7 operations across 3 paths, and defines 4 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.

7 operations 3 paths 4 schemas 1 DELETE2 GET1 POST3 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 Contact 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 7

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

Contact 7
GET
/lists/{list_id}/contacts
Get contacts
getContacts 3 params → 200
POST
/lists/{list_id}/contacts
Create contact
createContact 1 param body → 200
PUT
/lists/{list_id}/contacts
Create or update contact
createOrUpdateContact 1 param body → 200
PUT
/lists/{list_id}/contacts/batch
Update multiple list contacts
updateMultipleContacts 1 param body → 200
GET
/lists/{list_id}/contacts/{contact_id}
Get contact
getContact 2 params → 200
PUT
/lists/{list_id}/contacts/{contact_id}
Update contact
updateContact 2 params body → 200
DELETE
/lists/{list_id}/contacts/{contact_id}
Delete contact
deleteContact 2 params → 204

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are Contact (7 properties), ContactWrite (4 properties), Paging (2 properties), ContactCollection (2 properties). Each schema is shown below with its type and property counts.

ContactWrite
object
4 properties 1 required
ContactCollection
object
2 properties
Contact
object
Details of a contact of a list.
7 properties
Paging
object
Cursor pagination metadata.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

emailoctopus-contact-api-openapi.yml Raw ↑

Other APIs EmailOctopus publishes across the network.

EmailOctopus Automation API
EmailOctopus Campaign API
EmailOctopus Field API
EmailOctopus List API
EmailOctopus Tag API