aYOUne
← CRM API

Segments

Singular: Segment — Base-URL: https://crm-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": "65e0b0a8121b7d48fe158528",
    "name": "-",
    "color": "#ffffff",
    "user_count": 0,
    "so": 0,
    "show_overview": true,
    "createdBy": "6045f4d25704710012485569",
    "fields": [],
    "createdAt": "2024-02-29T16:28:24.412Z",
    "updatedAt": "2024-02-29T16:28:24.412Z"
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://crm-api.ayoune.app/segments/65e0b0a8121b7d48fe158528",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "relations": [],
    "debugId": "6a62df80d98fe96440cc92ea",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_SEGMENT",
        "href": "https://api.ayoune.app/crm/segments/65e0b0a8121b7d48fe158528/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_SEGMENT",
        "href": "https://api.ayoune.app/crm/segments/65e0b0a8121b7d48fe158528/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.46.1",
      "core": "2026.258.0"
    },
    "rateLimit": {
      "limit": "2500",
      "remaining": "2282",
      "reset": "1784868196",
      "resetDate": "Fri Jul 24 2026"
    },
    "responseTime": 34.754909,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpunkte

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

SDK

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

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

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

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

Weiterführend