aYOUne
← Konfiguration API

ContentSnippets

Singular: ContentSnippet — Base-URL: https://config-api.ayoune.app — Zugriff: CRUD — Maschinenlesbare Beschreibung (JSON · YAML)

play_circle Jetzt ausprobieren beta

Requests werden über den consumer-app Proxy an *.ayoune.app weitergeleitet. Tokens bleiben im Browser und werden pro Call mitgesendet.

Beispiel-Response (aufgezeichnet) Beispiel

Eine echte, zuvor aufgezeichnete GET /:id-Antwort dieses Endpunkts — nicht der Live-Call oben. Sensible Felder sind maskiert.

{
  "payload": {
    "cache": {
      "enabled": false,
      "time": 12,
      "html": "",
      "data": ""
    },
    "_id": "65e0aff7121b7d48fe156510",
    "pug": "",
    "pug_tablet": "",
    "pug_mobile": "",
    "html": "",
    "html_tablet": "",
    "html_phone": "",
    "isDraft": true,
    "createdBy": "6045f4d25704710012485569",
    "data": [],
    "createdAt": "2024-02-29T16:25:27.524Z",
    "updatedAt": "2024-02-29T16:25:27.524Z"
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://config-api.ayoune.app/contentsnippets/65e0aff7121b7d48fe156510",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "relations": [
      {
        "rel": "Consumers",
        "title": "MODEL_CONSUMER",
        "href": "https://api.ayoune.app/crm/consumers",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "crm.consumers"
      }
    ],
    "debugId": "6a8e616aa2d283bdc92ce4dc",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_CONTENTSNIPPET",
        "href": "https://api.ayoune.app/config/contentsnippets/65e0aff7121b7d48fe156510/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_CONTENTSNIPPET",
        "href": "https://api.ayoune.app/config/contentsnippets/65e0aff7121b7d48fe156510",
        "method": "delete",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.152.0",
      "core": "2026.319.0"
    },
    "rateLimit": {
      "limit": "2500",
      "remaining": "1917",
      "reset": "1787716882",
      "resetDate": "Wed Aug 26 2026"
    },
    "responseTime": 922.517325,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpunkte

MethodePathBeschreibungRight
GET /contentsnippets Liste mit Filtern/Paginierung config.contentsnippets.view
GET /contentsnippets/:id Einzelner Datensatz config.contentsnippets.view
POST /contentsnippets Neuen Datensatz erstellen config.contentsnippets.new
PUT /contentsnippets Datensatz aktualisieren config.contentsnippets.edit
DELETE /contentsnippets/:id Datensatz löschen config.contentsnippets.delete

SDK

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

// Alle abrufen
const list = await ay.config.contentSnippets.find().limit(10).exec();

// Einzelnen Datensatz
const one = await ay.config.contentSnippets.findById('OBJECT_ID').exec();

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

Weiterführend