aYOUne
← Configuration API

NewsletterTypes

Singular: NewsletterType — Base URL: https://config-api.ayoune.app — Access: CRUD — Machine-readable spec (JSON · YAML)

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": "6aa377a40a0df7eaaeb8c6a6",
    "name": "DEMOCRATIC_BLUSH_MACE WINDU",
    "createdBy": "6045f4d25704710012485569",
    "shares": [],
    "createdAt": "2026-09-11T03:38:12.645Z",
    "updatedAt": "2026-09-11T03:38:14.041Z",
    "modifiedBy": "6045f4d25704710012485569"
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://config-api.ayoune.app/newslettertypes/6aa377a40a0df7eaaeb8c6a6",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "relations": [],
    "debugId": "6aa377a60a0df7eaaeb8c726",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_NEWSLETTERTYPE",
        "href": "https://api.ayoune.app/config/newslettertypes/6aa377a40a0df7eaaeb8c6a6/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_NEWSLETTERTYPE",
        "href": "https://api.ayoune.app/config/newslettertypes/6aa377a40a0df7eaaeb8c6a6",
        "method": "delete",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.161.0",
      "core": "2026.335.0"
    },
    "rateLimit": {
      "limit": "2500",
      "remaining": "919",
      "reset": "1789099354",
      "resetDate": "Fri Sep 11 2026"
    },
    "responseTime": 316.830398,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpoints

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

SDK

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

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

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

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

See also