aYOUne
← Marketing API

ChatApps

Singular: ChatApp — Base-URL: https://marketing-api.ayoune.app — Zugriff: CRUD

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": {
    "_id": "65e074f47631a977e1babe20",
    "active": true,
    "createdBy": "6045f4d25704710012485569",
    "createdAt": "2024-02-29T12:13:40.152Z",
    "updatedAt": "2024-02-29T12:13:40.152Z"
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://marketing-api.ayoune.app/chatapps/65e074f47631a977e1babe20",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "relations": [],
    "debugId": "6a61945ff78ad61f1990d67f",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_CHATAPP",
        "href": "https://api.ayoune.app/marketing/chatapps/65e074f47631a977e1babe20/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_CHATAPP",
        "href": "https://api.ayoune.app/marketing/chatapps/65e074f47631a977e1babe20/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.24.4",
      "core": "2026.257.1"
    },
    "rateLimit": {
      "limit": "2500",
      "remaining": "2338",
      "reset": "1784783437",
      "resetDate": "Thu Jul 23 2026"
    },
    "responseTime": 63.371549,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpunkte

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

SDK

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

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

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

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

Weiterführend