Eden Newsletters API

openapi: 3.2.0
info:
  title: Eden store Newsletters API
  version: 1.0.0
  summary: Sales, customers, products, communities, email list, and webhooks for an Eden store.
  description: 'Record sales from any checkout, give and remove access, list every sale and customer, make and publish products, post in your communities, manage the store''s email list, and get events by webhook.


    **Sign in:** `Authorization: Bearer `, an Eden API key from Settings → API with Full access, or Custom with Store on Edit (Store on Read can only make GET calls). A key reaches one store, picked when it''s made. Store calls need Starter or above.


    **Lists** take `limit` (1 to 100), `starting_after` (the last page''s `next_cursor`), `created_after`, and `created_before`, and answer `{ ok, data, has_more, next_cursor }`.


    Your workspace (Discover, scheduling, boards, notes, Custom AIs) is a separate spec: https://mcp.eden.so/v1/openapi.json'
  contact:
    name: Eden
    url: https://eden.so/help/api/api-reference/
  termsOfService: https://eden.so/terms/
servers:
- url: https://api.eden.so
  description: Eden store API
security:
- apiKey: []
tags:
- name: Newsletters
paths:
  /store-app/v1/newsletters:
    get:
      operationId: getNewsletters
      summary: List newsletters
      description: The store's newsletters with their public page, free and paid subscriber counts, and paid tier product.
      tags:
      - Newsletters
      responses:
        '200':
          description: 'Done. Most answers carry `ok: true`.'
          content:
            application/json:
              schema:
                type: object
        '400':
          $ref: '#/components/responses/Failure'
        '401':
          $ref: '#/components/responses/Failure'
        '402':
          $ref: '#/components/responses/Failure'
        '403':
          $ref: '#/components/responses/Failure'
        '404':
          $ref: '#/components/responses/Failure'
        '409':
          $ref: '#/components/responses/Failure'
        '422':
          $ref: '#/components/responses/Failure'
        '429':
          $ref: '#/components/responses/Failure'
        '500':
          $ref: '#/components/responses/Failure'
  /store-app/v1/newsletters/{newsletterId}/subscribers:
    post:
      operationId: postNewslettersNewsletterIdSubscribers
      summary: Add a subscriber
      description: 'Adds one person to the newsletter, the same as signing up on its page: they get the newsletter''s tag and its welcome email (once email marketing is on), and the store''s signup routing runs. `status` is `added`, `already_subscribed`, or `kept_off` (they unsubscribed, bounced, or marked spam before; Eden never adds them back). Run this from your server: the key must stay private.'
      tags:
      - Newsletters
      parameters:
      - name: newsletterId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - email
              properties:
                email:
                  minLength: 3
                  maxLength: 320
                  type: string
                name:
                  maxLength: 120
                  type: string
                tag_ids:
                  maxItems: 10
                  type: array
                  items:
                    maxLength: 64
                    type: string
      responses:
        '200':
          description: 'Done. Most answers carry `ok: true`.'
          content:
            application/json:
              schema:
                type: object
        '400':
          $ref: '#/components/responses/Failure'
        '401':
          $ref: '#/components/responses/Failure'
        '402':
          $ref: '#/components/responses/Failure'
        '403':
          $ref: '#/components/responses/Failure'
        '404':
          $ref: '#/components/responses/Failure'
        '409':
          $ref: '#/components/responses/Failure'
        '422':
          $ref: '#/components/responses/Failure'
        '429':
          $ref: '#/components/responses/Failure'
        '500':
          $ref: '#/components/responses/Failure'
  /store-app/v1/signup-forms:
    get:
      operationId: getSignupForms
      summary: List signup forms
      description: 'Signup forms for your website, each with `submit_url` (public, no key needed: post `email`, and `first_name` or `field_` answers, as JSON or a normal form) and `code` (script, iframe, and plain HTML to paste).'
      tags:
      - Newsletters
      responses:
        '200':
          description: 'Done. Most answers carry `ok: true`.'
          content:
            application/json:
              schema:
                type: object
        '400':
          $ref: '#/components/responses/Failure'
        '401':
          $ref: '#/components/responses/Failure'
        '402':
          $ref: '#/components/responses/Failure'
        '403':
          $ref: '#/components/responses/Failure'
        '404':
          $ref: '#/components/responses/Failure'
        '409':
          $ref: '#/components/responses/Failure'
        '422':
          $ref: '#/components/responses/Failure'
        '429':
          $ref: '#/components/responses/Failure'
        '500':
          $ref: '#/components/responses/Failure'
components:
  schemas:
    Failure:
      type: object
      required:
      - ok
      - error
      properties:
        ok:
          type: boolean
          const: false
        error:
          type: string
          description: A machine code, like `product_not_found`.
        message:
          type: string
  responses:
    Failure:
      description: The call failed. `error` and `message` say why.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Failure'
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      bearerFormat: eden_pat_…
      description: An Eden API key from Settings → API, or the Zapier app's OAuth token.