Reference

What the API does not do

This page lists what is not in the API. Each item is a fact about the current version.

Writes#

The API has ten write endpoints, and they are the whole write surface. It does not offer:

  • Creating campaigns, starting a draft for the first time or editing steps.
  • Deleting prospects.
  • Managing API tokens.
  • Managing the workspace webhook, which means its URL and its signing secret.

Data#

  • Prospects and campaigns have no updated_at and no updated_since filter. Their tables carry no modification timestamp.
  • The API does not return the text of a reply. It returns the classification and a 160 character snippet.
  • The API does not return the content of an offer document. It returns metadata and reading statistics.
  • The global suppression list of anymail is not visible. The list endpoint shows the suppressions of your workspace.

Protocol#

  • No bulk endpoints. The enrolment call takes up to 200 items and is the closest equivalent.
  • No ETag.
  • No CORS, so a browser page cannot call the API.
  • No OAuth. Access uses workspace API tokens.
  • No scopes. A token has full access to its workspace.
  • No OpenAPI document. This site is the specification.

Events#

  • There is no webhook for opened or delivered.
  • Subscriptions through the API cover new_reply, positive_reply, bounce and unsubscribe. There is no subscription for sent or clicked. The workspace webhook delivers sent and clicked.

MCP#

  • The MCP server has no resources and no prompts.
  • It has no sessions and sends no notifications.
  • It does what the REST API does. Anything in the lists above is also missing from MCP.