aYOUne
← Marketing API

Campaigns

Singular: Campaign — 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": "65e074f17631a977e1babdb6",
    "type": "Basic",
    "score": 10,
    "createdBy": "6045f4d25704710012485569",
    "forms": [],
    "mails": [],
    "newsletters": [],
    "ctas": [],
    "landingpages": [],
    "createdAt": "2024-02-29T12:13:37.076Z",
    "updatedAt": "2024-02-29T12:13:37.076Z"
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://marketing-api.ayoune.app/campaigns/65e074f17631a977e1babdb6",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "relations": [],
    "debugId": "6a619458f78ad61f1990d434",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_CAMPAIGN",
        "href": "https://api.ayoune.app/marketing/campaigns/65e074f17631a977e1babdb6/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_CAMPAIGN",
        "href": "https://api.ayoune.app/marketing/campaigns/65e074f17631a977e1babdb6/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.24.4",
      "core": "2026.257.1"
    },
    "rateLimit": {
      "limit": "2500",
      "remaining": "2368",
      "reset": "1784783437",
      "resetDate": "Thu Jul 23 2026"
    },
    "responseTime": 76.483218,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpunkte

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

SDK

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

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

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

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

Weiterführend