Show more

Use to navigate results, ENTER to select one, ESC to close

Type in any word to easily find the endpoint, property or group of operations you are looking for.
API Explorer API changelog
Download source
  • JSON OpenAPI specification
  • YAML OpenAPI specification
Guides
REST API logo

Topics

  • Introduction
  • Authentication

Newsletters and people

  • Newsletters
    • List newsletters GET
    • Retrieve a newsletter GET
  • Team
    • List a newsletter's team GET
    • List this account's memberships GET
  • Users
    • Retrieve the authenticated account GET
    • Retrieve a user GET
  • Search
    • Search your newsletters GET

Publishing

  • Articles
    • List a newsletter's articles GET
    • Create an article POST
    • Retrieve an article GET
    • Edit an article PATCH
    • List an article's authors GET
    • Store an image for an article POST
    • Send a test copy of an article POST
    • Schedule an article POST
    • Cancel a scheduled article POST
    • Send an article to the list POST
    • List the articles this account saved GET
    • List the articles this account liked GET
  • Highlights
    • List an article's highlights GET
    • Retrieve a highlight GET

Community

  • Threads
    • List a newsletter's threads GET
    • Start a thread POST
    • Retrieve a thread GET
    • Set who a conversation is private to PATCH
    • Put a thread on the global feed POST
    • Reply in a thread POST
  • Messages
    • List a thread's messages GET
    • Retrieve a message GET
  • Chat rooms
    • List a newsletter's chat rooms GET
    • Retrieve a chat room GET

Audience

  • Subscribers
    • List a newsletter's subscribers GET
    • Add a subscriber POST
    • Retrieve a subscriber GET
    • Erase a subscriber DELETE
    • Update a subscriber PATCH
    • List the newsletters this account subscribes to GET
    • List a newsletter's community GET
  • Subscriber tags
    • List a newsletter's tags GET
    • Create a tag POST
    • Retrieve a tag GET
    • Delete a tag DELETE
    • Rename a tag PATCH
    • Apply a tag to many subscribers POST
    • Apply a tag to a subscriber POST
    • Take a tag off a subscriber DELETE

Insights

  • Engagement
    • List a newsletter's subscriber insights GET
    • List a newsletter's engagement events GET
  • Metrics
    • Retrieve a newsletter's headline numbers GET
    • Retrieve a newsletter's acquisition breakdown GET
    • Retrieve one newsletter metric bucketed over time GET
    • Retrieve one article's performance GET

Sending and domains

  • Sends
    • List a newsletter's sends GET
    • Retrieve a send GET
  • Senders
    • List a newsletter's sending addresses GET
    • Retrieve a sending address GET
  • Website domains
    • List a newsletter's website domains GET
    • Retrieve a website domain GET
    • Change what a website domain serves PATCH
  • Automations
    • List a newsletter's automations GET
    • Create an automation POST
    • List the events an automation can trigger on GET
    • Retrieve an automation GET
    • Archive an automation DELETE
    • Update an automation PATCH
    • Turn an automation on POST
    • Turn an automation off POST
    • List an automation's runs GET
    • Send a test copy of one step's email POST
    • Retrieve an automation run GET

Creator websites

  • Creator websites
    • List a newsletter's website pages GET
    • Create a website page POST
    • Retrieve a website page GET
    • Delete a website page DELETE
    • Change a website page PATCH
    • Publish a website page POST
    • Unpublish a website page POST
    • Store a website asset POST
    • List a newsletter's publishable keys GET
    • Create a publishable key POST
    • Revoke a publishable key DELETE
    • Rotate a publishable key POST

Platform

  • Platform
    • Service status GET
    • Retrieve the calling credential's rate limit state GET
    • What this credential may call GET
    • List this newsletter's API keys GET
    • Retrieve an API key GET
    • Revoke an API key DELETE
  • Event delivery
    • List where a newsletter's events go GET
    • List what was delivered where, and how it went GET
    • Retrieve one delivery attempt GET
    • Send an event to a destination again POST
    • Open the event delivery portal POST
  • Webhooks
    • Article like added or removed POST
    • Article published POST
    • Article read POST
    • Article scheduled POST
    • Automation run completed POST
    • Automation run ended early POST
    • Automation run started POST
    • Billing subscription state changed POST
    • Delivery bounced POST
    • Delivery link clicked POST
    • Delivery marked as spam POST
    • Delivery accepted by the recipient server POST
    • Delivery opened POST
    • Custom website domain verified POST
    • Highlight created POST
    • Import finished POST
    • Message created POST
    • Send completed POST
    • Send failed POST
    • Sender verified POST
    • Subscriber created POST
    • Subscriber insight status changed POST
    • Subscriber tag added or removed POST
    • Subscriber unsubscribed POST
    • Thread created POST
    • Thread published to the feed POST
Powered by Bump.sh
API Explorer API changelog
Download source
  • JSON OpenAPI specification
  • YAML OpenAPI specification
Guides
REST API logo