aYOUne
← Marketing API

SeriesNewsletters

Singular: SeriesNewsletter — Base URL: https://marketing-api.ayoune.app — Access: CRUD

play_circle Try it now beta

Requests are proxied through the consumer-app to *.ayoune.app. Tokens stay in your browser and are forwarded per call.

Example response (recorded) sample

A real, previously recorded GET /:id response of this endpoint — not the live call above. Sensitive fields are masked.

{
  "payload": {
    "_id": "65e0b146121b7d48fe1593c7",
    "name": "",
    "promotional": true,
    "needsApproval": true,
    "editor": "6045f4d25704710012485569",
    "attachments": [],
    "interval": 4,
    "intervalUnit": "weeks",
    "createdBy": "6045f4d25704710012485569",
    "createdAt": "2024-02-29T16:31:03.001Z",
    "updatedAt": "2024-02-29T16:31:03.001Z"
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://marketing-api.ayoune.app/seriesnewsletters/65e0b146121b7d48fe1593c7",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "relations": [
      {
        "rel": "EMailTemplates",
        "title": "MODEL_EMAILTEMPLATE",
        "href": "https://api.ayoune.app/config/emailtemplates",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.emailtemplates"
      },
      {
        "rel": "Mails",
        "title": "MODEL_MAIL",
        "href": "https://api.ayoune.app/config/mails",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.mails"
      },
      {
        "rel": "ConsumerLists",
        "title": "MODEL_CONSUMERLIST",
        "href": "https://api.ayoune.app/crm/consumerlists",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "crm.consumerlists"
      },
      {
        "rel": "NewsletterTypes",
        "title": "MODEL_NEWSLETTERTYPE",
        "href": "https://api.ayoune.app/config/newslettertypes",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.newslettertypes"
      },
      {
        "rel": "ConsumerLists",
        "title": "MODEL_CONSUMERLIST",
        "href": "https://api.ayoune.app/crm/consumerlists",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "crm.consumerlists"
      }
    ],
    "debugId": "6a6194bcf78ad61f1990fac6",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_SERIESNEWSLETTER",
        "href": "https://api.ayoune.app/marketing/seriesnewsletters/65e0b146121b7d48fe1593c7/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_SERIESNEWSLETTER",
        "href": "https://api.ayoune.app/marketing/seriesnewsletters/65e0b146121b7d48fe1593c7/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.24.4",
      "core": "2026.257.1"
    },
    "rateLimit": {
      "limit": "2500",
      "remaining": "1810",
      "reset": "1784783437",
      "resetDate": "Thu Jul 23 2026"
    },
    "responseTime": 17.138319,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpoints

MethodPathDescriptionRight
GET /seriesnewsletters List with filters/pagination marketing.seriesnewsletters.view
GET /seriesnewsletters/:id Single record marketing.seriesnewsletters.view
POST /seriesnewsletters Create new record marketing.seriesnewsletters.new
PUT /seriesnewsletters Update record marketing.seriesnewsletters.edit
DELETE /seriesnewsletters/:id Delete record marketing.seriesnewsletters.delete

SDK

import { aYOUne } from '@tolinax/ayoune';
const ay = new aYOUne('pat_your_token');

// List all
const list = await ay.marketing.seriesNewsletters.find().limit(10).exec();

// Single record
const one = await ay.marketing.seriesNewsletters.findById('OBJECT_ID').exec();

// Create
const created = await ay.marketing.seriesNewsletters.create({ name: 'Foo' });

See also