aYOUne
← Marketing API

DesktopClients

Singular: DesktopClient — 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": "65e07629072ab6fcee60f8df",
    "os": "Chrome",
    "createdBy": "6045f4d25704710012485569",
    "last_active": "2024-02-29T12:18:49.310Z",
    "createdAt": "2024-02-29T12:18:49.312Z",
    "updatedAt": "2024-02-29T12:18:49.312Z"
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://marketing-api.ayoune.app/desktopclients/65e07629072ab6fcee60f8df",
        "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": "6a619477f78ad61f1990dee3",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_DESKTOPCLIENT",
        "href": "https://api.ayoune.app/marketing/desktopclients/65e07629072ab6fcee60f8df/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_DESKTOPCLIENT",
        "href": "https://api.ayoune.app/marketing/desktopclients/65e07629072ab6fcee60f8df/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.24.4",
      "core": "2026.257.1"
    },
    "rateLimit": {
      "limit": "2500",
      "remaining": "2209",
      "reset": "1784783437",
      "resetDate": "Thu Jul 23 2026"
    },
    "responseTime": 83.673408,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpunkte

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

SDK

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

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

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

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

Weiterführend