Docs

Apps send with a Bearer key. Mailbox, campaigns, people lists, automations, apps, tags, and team use the operator session — no need to click through the console once you have a cookie or a key.

Operations

  • GET/v1List docs URLs and operations
  • GET/v1/openapi.jsonOpenAPI 3.1 document
  • POST/v1/messagesQueue a notification
  • GET/api/notifications/appsList apps
  • POST/api/notifications/appsCreate an app and return its API secret once
  • GET/api/notifications/mailboxList mailbox conversations (no HTML bodies)
  • GET/api/notifications/mailbox/{id}Read a letter including HTML
  • POST/api/notifications/mailbox/sendCompose or reply from Mailbox
  • GET/api/notifications/campaignsList campaigns
  • POST/api/notifications/campaignsCreate a campaign for an app
  • POST/api/notifications/campaigns/{id}/contentSave campaign copy
  • POST/api/notifications/campaigns/{id}/sendQueue a campaign to its audience
  • GET/api/notifications/contact-listsList people lists
  • POST/api/notifications/contact-listsCreate a people list
  • POST/api/notifications/contact-lists/{id}/importImport CSV members
  • GET/api/notifications/automationsList automations
  • POST/api/notifications/automationsCreate an automation
  • GET/api/notifications/tagsList app message tags
  • POST/api/notifications/tagsAdd a tag to an app
  • DELETE/api/notifications/tagsRemove a tag from an app
  • GET/api/notifications/teamList people who can sign in to the console
  • GET/api/notifications/templatesList templates
  • POST/api/notifications/templatesCreate or update a template
  • GET/api/notifications/webhooksList status-update endpoints
  • POST/api/notifications/webhooksAdd a status-update URL

Groups in the spec: /v1, /v1/openapi.json, /v1/messages, apps, mailbox, campaigns, contact-lists, automations, tags, team, templates, webhooks.