EmailOctopus

EmailOctopus Field API

Define the per-list custom fields contact records are written against. Fields are keyed by a stable tag slug and typed text, number or date, with optional choices and a fallback value. 3 operation(s) in the EmailOctopus v2 OpenAPI 3.1.0.

GitHub OpenAPI

Operations 3

POST /lists/{list_id}/fields Create field #
PUT /lists/{list_id}/fields/{tag} Update field #
DELETE /lists/{list_id}/fields/{tag} Delete field #

Documentation

📖
Documentation
https://emailoctopus.com/api-documentation/v2
📖
APIReference
https://emailoctopus.com/api-documentation/v2

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/emailoctopus/refs/heads/main/openapi/emailoctopus-field-api-openapi.yml

Other Resources

🔗
Overlay
https://raw.githubusercontent.com/api-evangelist/emailoctopus/refs/heads/main/overlays/emailoctopus-field-overlay.yaml
🔗
PostmanCollection
https://raw.githubusercontent.com/api-evangelist/emailoctopus/refs/heads/main/collections/emailoctopus-field-api.postman_collection.json
🔗
OpenCollection
https://raw.githubusercontent.com/api-evangelist/emailoctopus/refs/heads/main/collections/emailoctopus-field-api.opencollection.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/emailoctopus-field-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

emailoctopus-field-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: EmailOctopus v2 Field API
  description: '# Introduction


    The EmailOctopus API allows you to manage resources and perform actions within the platform programmatically.'
  version: 2.0.0
  x-logo:
    url: /build/images/logo.CRVwHzot.svg
    altText: EmailOctopus Logo
    href: '#'
servers:
- url: https://api.emailoctopus.com
  description: ''
security:
- api_key: []
tags:
- name: Field
  description: 'Fields are custom data points associated with contacts within a specific list.

    You can create additional fields to capture specific information about your contacts, such as birthday, location, age or dietary preferences. These fields can be useful for sending more personalised and targeted emails.'
paths:
  /lists/{list_id}/fields:
    post:
      operationId: api_lists_list_idfields_post
      tags:
      - Field
      responses:
        '201':
          description: Successful response
          content:
            application/json:
              schema:
                oneOf:
                - title: Text, number or date field
                  description: A field that accepts a single value.
                  type: object
                  properties:
                    label:
                      type: string
                      description: A human readable label for the field.
                      example: What is your hometown?
                    tag:
                      type: string
                      description: The ID used to reference the field in your emails.
                      example: Hometown
                    type:
                      type: string
                      description: The type of the field.
                      example: text
                      enum:
                      - text
                      - number
                      - date
                    fallback:
                      type:
                      - string
                      - null
                      description: A default value for the field, used in campaigns when there is no other value available.
                      example: Unknown
                  required:
                  - label
                  - tag
                  - type
                - title: Choice field
                  description: A field that accepts a single value from a list of choices.
                  type: object
                  properties:
                    label:
                      type: string
                      description: A human readable label for the field.
                      example: What is your hometown?
                    tag:
                      type: string
                      description: The ID used to reference the field in your emails.
                      example: Hometown
                    type:
                      type: string
                      description: The type of the field.
                      example: choice_single
                      enum:
                      - choice_single
                      - choice_multiple
                    choices:
                      type: array
                      description: An array of choices for the field.
                      items:
                        type: string
                      example:
                      - One
                      - Two
                    fallback:
                      type:
                      - string
                      - null
                      description: A default value for the field, used in campaigns when there is no other value available.
                      example: Unknown
                  required:
                  - label
                  - tag
                  - type
                  - choices
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                type: object
                properties:
                  type:
                    type: string
                    description: Error type.
                    enum:
                    - https://emailoctopus.com/api-documentation/v2#bad-request
                    default: https://emailoctopus.com/api-documentation/v2#bad-request
                    example: https://emailoctopus.com/api-documentation/v2#bad-request
                  title:
                    type: string
                    description: General error title.
                    default: An error occurred.
                  detail:
                    type: string
                    description: Error description.
                    default: Bad request.
                  status:
                    type: string
                    description: Response status.
                    default: 400
                  errors:
                    type: array
                    items:
                      type: object
                      required:
                      - detail
                      properties:
                        pointer:
                          type: string
                          description: A JSON Pointer [RFC6901] to the value in the request document that caused the error.
                          default: name
                        parameter:
                          type: string
                          description: Name of the url parameter containing the error.
                          default: list_id
                        detail:
                          type: string
                          description: Error description.
                          default: This value should be between 1 and 100.
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  type:
                    type: string
                    description: Error type.
                    enum:
                    - https://emailoctopus.com/api-documentation/v2#unauthorized
                  title:
                    type: string
                    description: General error title.
                    default: An error occurred.
                  detail:
                    type: string
                    description: Error description.
                    default: Invalid key.
                  status:
                    type: string
                    description: Response status.
                    default: 401
        '403':
          description: Access denied.
          content:
            application/json:
              schema:
                type: object
                properties:
                  type:
                    type: string
                    description: Error type.
                    enum:
                    - https://emailoctopus.com/api-documentation/v2#access-denied
                  title:
                    type: string
                    description: General error title.
                    default: An error occurred.
                  detail:
                    type: string
                    description: Error description.
                    default: Access denied.
                  status:
                    type: string
                    description: Response status.
                    default: 403
        '404':
          description: Resource not found.
          content:
            application/json:
              schema:
                type: object
                properties:
                  type:
                    type: string
                    description: Error type.
                    enum:
                    - https://emailoctopus.com/api-documentation/v2#not-found
                  title:
                    type: string
                    description: General error title.
                    default: An error occurred.
                  detail:
                    type: string
                    description: Error description.
                    default: Resource not found.
                  status:
                    type: string
                    description: Response status.
                    default: 404
        '409':
          description: Conflict.
          content:
            application/json:
              schema:
                type: object
                properties:
                  type:
                    type: string
                    description: Error type.
                    enum:
                    - https://emailoctopus.com/api-documentation/v2#conflict
                  title:
                    type: string
                    description: General error title.
                    default: An error occurred.
                  detail:
                    type: string
                    description: Error description.
                    default: Resource already exists.
                  status:
                    type: string
                    description: Response status.
                    default: 409
        '422':
          description: Unprocessable content.
          content:
            application/json:
              schema:
                type: object
                properties:
                  type:
                    type: string
                    description: Error type
                    example: https://emailoctopus.com/api-documentation/v2#unprocessable-content
                  title:
                    type: string
                    description: 'General error title: `An error occurred.`'
                    example: An error occurred.
                  detail:
                    type: string
                    description: 'Error description: `Unprocessable content.`'
                    example: Unprocessable content.
                  status:
                    type: string
                    description: 'Response status: `422`'
                    example: 422
                  errors:
                    type: array
                    description: Validation errors
                    items:
                      type: object
                      properties:
                        detail:
                          type: string
                          description: Error description.
                        pointer:
                          type: string
                          description: A JSON Pointer <a href="https://datatracker.ietf.org/doc/html/rfc7807" target="_blank">[RFC 7807]</a> to the value in the request document that caused the error.
                      example:
                        detail: This value must be string type, int provided.
                        pointer: /tag
      summary: Create field
      description: ''
      parameters:
      - name: list_id
        in: path
        description: The ID of the list.
        required: true
        deprecated: false
        schema:
          type: string
        style: simple
        explode: false
        example: 00000000-0000-0000-0000-000000000000
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              oneOf:
              - title: Text, number or date field
                description: A field that accepts a single value.
                type: object
                properties:
                  label:
                    type: string
                    description: A human readable label for the field.
                    example: What is your hometown?
                  tag:
                    type: string
                    description: The ID used to reference the field in your emails.
                    example: Hometown
                  type:
                    type: string
                    description: The type of the field.
                    example: text
                    enum:
                    - text
                    - number
                    - date
                  fallback:
                    type:
                    - string
                    - null
                    description: A default value for the field, used in campaigns when there is no other value available.
                    example: Unknown
                required:
                - label
                - tag
                - type
              - title: Choice field
                description: A field that accepts a single value from a list of choices.
                type: object
                properties:
                  label:
                    type: string
                    description: A human readable label for the field.
                    example: What is your hometown?
                  tag:
                    type: string
                    description: The ID used to reference the field in your emails.
                    example: Hometown
                  type:
                    type: string
                    description: The type of the field.
                    example: choice_single
                    enum:
                    - choice_single
                    - choice_multiple
                  choices:
                    type: array
                    description: An array of choices for the field.
                    items:
                      type: string
                    example:
                    - One
                    - Two
                  fallback:
                    type:
                    - string
                    - null
                    description: A default value for the field, used in campaigns when there is no other value available.
                    example: Unknown
                required:
                - label
                - tag
                - type
                - choices
        required: true
  /lists/{list_id}/fields/{tag}:
    put:
      operationId: api_lists_list_idfields_tag_put
      tags:
      - Field
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                oneOf:
                - title: Text, number or date field
                  description: A field that accepts a single value.
                  type: object
                  properties:
                    label:
                      type: string
                      description: A human readable label for the field.
                      example: What is your hometown?
                    tag:
                      type: string
                      description: The ID used to reference the field in your emails.
                      example: Hometown
                    type:
                      type: string
                      description: The type of the field.
                      example: text
                      enum:
                      - text
                      - number
                      - date
                    fallback:
                      type:
                      - string
                      - null
                      description: A default value for the field, used in campaigns when there is no other value available.
                      example: Unknown
                  required:
                  - label
                  - tag
                  - type
                - title: Choice field
                  description: A field that accepts a single value from a list of choices.
                  type: object
                  properties:
                    label:
                      type: string
                      description: A human readable label for the field.
                      example: What is your hometown?
                    tag:
                      type: string
                      description: The ID used to reference the field in your emails.
                      example: Hometown
                    type:
                      type: string
                      description: The type of the field.
                      example: choice_single
                      enum:
                      - choice_single
                      - choice_multiple
                    choices:
                      type: array
                      description: An array of choices for the field.
                      items:
                        type: string
                      example:
                      - One
                      - Two
                    fallback:
                      type:
                      - string
                      - null
                      description: A default value for the field, used in campaigns when there is no other value available.
                      example: Unknown
                  required:
                  - label
                  - tag
                  - type
                  - choices
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                type: object
                properties:
                  type:
                    type: string
                    description: Error type.
                    enum:
                    - https://emailoctopus.com/api-documentation/v2#bad-request
                    default: https://emailoctopus.com/api-documentation/v2#bad-request
                    example: https://emailoctopus.com/api-documentation/v2#bad-request
                  title:
                    type: string
                    description: General error title.
                    default: An error occurred.
                  detail:
                    type: string
                    description: Error description.
                    default: Bad request.
                  status:
                    type: string
                    description: Response status.
                    default: 400
                  errors:
                    type: array
                    items:
                      type: object
                      required:
                      - detail
                      properties:
                        pointer:
                          type: string
                          description: A JSON Pointer [RFC6901] to the value in the request document that caused the error.
                          default: name
                        parameter:
                          type: string
                          description: Name of the url parameter containing the error.
                          default: list_id
                        detail:
                          type: string
                          description: Error description.
                          default: This value should be between 1 and 100.
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  type:
                    type: string
                    description: Error type.
                    enum:
                    - https://emailoctopus.com/api-documentation/v2#unauthorized
                  title:
                    type: string
                    description: General error title.
                    default: An error occurred.
                  detail:
                    type: string
                    description: Error description.
                    default: Invalid key.
                  status:
                    type: string
                    description: Response status.
                    default: 401
        '403':
          description: Access denied.
          content:
            application/json:
              schema:
                type: object
                properties:
                  type:
                    type: string
                    description: Error type.
                    enum:
                    - https://emailoctopus.com/api-documentation/v2#access-denied
                  title:
                    type: string
                    description: General error title.
                    default: An error occurred.
                  detail:
                    type: string
                    description: Error description.
                    default: Access denied.
                  status:
                    type: string
                    description: Response status.
                    default: 403
        '404':
          description: Resource not found.
          content:
            application/json:
              schema:
                type: object
                properties:
                  type:
                    type: string
                    description: Error type.
                    enum:
                    - https://emailoctopus.com/api-documentation/v2#not-found
                  title:
                    type: string
                    description: General error title.
                    default: An error occurred.
                  detail:
                    type: string
                    description: Error description.
                    default: Resource not found.
                  status:
                    type: string
                    description: Response status.
                    default: 404
        '409':
          description: Conflict.
          content:
            application/json:
              schema:
                type: object
                properties:
                  type:
                    type: string
                    description: Error type.
                    enum:
                    - https://emailoctopus.com/api-documentation/v2#conflict
                  title:
                    type: string
                    description: General error title.
                    default: An error occurred.
                  detail:
                    type: string
                    description: Error description.
                    default: Resource already exists.
                  status:
                    type: string
                    description: Response status.
                    default: 409
        '422':
          description: Unprocessable content.
          content:
            application/json:
              schema:
                type: object
                properties:
                  type:
                    type: string
                    description: Error type
                    example: https://emailoctopus.com/api-documentation/v2#unprocessable-content
                  title:
                    type: string
                    description: 'General error title: `An error occurred.`'
                    example: An error occurred.
                  detail:
                    type: string
                    description: 'Error description: `Unprocessable content.`'
                    example: Unprocessable content.
                  status:
                    type: string
                    description: 'Response status: `422`'
                    example: 422
                  errors:
                    type: array
                    description: Validation errors
                    items:
                      type: object
                      properties:
                        detail:
                          type: string
                          description: Error description.
                        pointer:
                          type: string
                          description: A JSON Pointer <a href="https://datatracker.ietf.org/doc/html/rfc7807" target="_blank">[RFC 7807]</a> to the value in the request document that caused the error.
                      example:
                        detail: This value must be string type, int provided.
                        pointer: /tag
      summary: Update field
      description: ''
      parameters:
      - name: list_id
        in: path
        description: The ID of the list.
        required: true
        deprecated: false
        schema:
          type: string
        style: simple
        explode: false
        example: 00000000-0000-0000-0000-000000000000
      - name: tag
        in: path
        description: A unique identifier for a field.
        required: true
        deprecated: false
        schema:
          type: string
        style: simple
        explode: false
        example: Hometown
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              title: Text, number or date field
              description: A field that accepts a single value.
              type: object
              properties:
                label:
                  type: string
                  description: A human readable label for the field.
                  example: What is your hometown?
                tag:
                  type: string
                  description: The ID used to reference the field in your emails.
                  example: Hometown
                type:
                  type: string
                  description: The type of the field.
                  example: text
                  enum:
                  - text
                  - number
                  - date
                fallback:
                  type:
                  - string
                  - null
                  description: A default value for the field, used in campaigns when there is no other value available.
                  example: Unknown
              required:
              - label
              - tag
              - type
        required: false
    delete:
      operationId: api_lists_list_idfields_tag_delete
      tags:
      - Field
      responses:
        '204':
          description: No content.
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                type: object
                properties:
                  type:
                    type: string
                    description: Error type
                    example: https://emailoctopus.com/api-documentation/v2#bad-request
                  title:
                    type: string
                    description: 'General error title: `An error occurred.`'
                    example: An error occurred.
                  detail:
                    type: string
                    description: 'Error description: `Bad request.`'
                    example: Bad request.
                  status:
                    type: string
                    description: 'Response status: `400`'
                    example: 400
                  errors:
                    type: array
                    description: Validation errors
                    items:
                      type: object
                      properties:
                        detail:
                          type: string
                          description: Error description.
                        parameter:
                          type: string
                          description: Name of the url parameter containing the error.
                      example:
                        detail: This value is not a valid UUID.
                        parameter: list_id
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  type:
                    type: string
                    description: Error type.
                    enum:
                    - https://emailoctopus.com/api-documentation/v2#unauthorized
                  title:
                    type: string
                    description: General error title.
                    default: An error occurred.
                  detail:
                    type: string
                    description: Error description.
                    default: Invalid key.
                  status:
                    type: string
                    description: Response status.
                    default: 401
        '403':
          description: Access denied.
          content:
            application/json:
              schema:
                type: object
                properties:
                  type:
                    type: string
                    description: Error type.
                    enum:
                    - https://emailoctopus.com/api-documentation/v2#access-denied
                  title:
                    type: string
                    description: General error title.
                    default: An error occurred.
                  detail:
                    type: string
                    description: Error description.
                    default: Access denied.
                  status:
                    type: string
                    description: Response status.
                    default: 403
        '404':
          description: Resource not found.
          content:
            application/json:
              schema:
                type: object
                properties:
                  type:
                    type: string
                    description: Error type.
                    enum:
                    - https://emailoctopus.com/api-documentation/v2#not-found
                  title:
                    type: string
                    description: General error title.
                    default: An error occurred.
                  detail:
                    type: string
                    description: Error description.
                    default: Resource not found.
                  status:
                    type: string
                    description: Response status.
                    default: 404
      summary: Delete field
      description: ''
      parameters:
      - name: list_id
        in: path
        description: The ID of the list.
        required: true
        deprecated: false
        schema:
          type: string
        style: simple
        explode: false
        example: 00000000-0000-0000-0000-000000000000
      - name: tag
        in: path
        description: A unique identifier for a field.
        required: true
        deprecated: false
        schema:
          type: string
        style: simple
        explode: false
        example: Hometown
components:
  securitySchemes:
    api_key:
      type: http
      description: You can obtain your API key at https://api.emailoctopus.com/developer/api-keys/create
      name: Authorization
      in: header
      scheme: bearer