Skip to content
aYOUne
← Marketing API

Partners

Singular: Partner — Base URL: https://marketing-api.ayoune.app — Access: CRUD — Machine-readable spec (JSON · YAML)

Try it now beta

Requests are proxied through the consumer-app to *.ayoune.app. Tokens stay in your browser and are forwarded per call.

Example response (recorded) sample

A real, previously recorded GET /:id response of this endpoint — not the live call above. Sensitive fields are masked.

{
  "payload": {
    "_id": "6a876aa5dc80e35f9099ced1",
    "name": "Beispiel-Partner Nord (Demo)",
    "slug": "beispiel-partner-nord",
    "shortDescription": "Demo-Datensatz zur Abnahme der W6-Welle. Kein echter Partner.",
    "description": "Dient ausschliesslich dem Sicht-Beleg des Partner-Verzeichnisses im tolinax TEST ACCOUNT.",
    "category": "Technologie",
    "websiteUrl": "https://example.com",
    "partnerLevel": "gold",
    "published": true,
    "_websites": [],
    "sortOrder": 1,
    "translations": {
      "en": {
        "name": "Example Partner North (Demo)",
        "shortDescription": "Demo record for the W6 acceptance test. Not a real partner."
      }
    },
    "isDraft": true,
    "createdBy": "5a76d07e2d8b3270ff6df587",
    "createdAt": "2026-08-20T20:59:17.910Z",
    "updatedAt": "2026-08-20T21:04:25.922Z",
    "modifiedBy": "5a76d07e2d8b3270ff6df587",
    "shares": []
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://marketing-api.ayoune.app/partners/6a876aa5dc80e35f9099ced1",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "relations": [
      {
        "rel": "Images",
        "title": "MODEL_IMAGE",
        "href": "https://api.ayoune.app/cms/images",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "cms.images"
      }
    ],
    "debugId": "6ac9bbaad942c8cd7c84bb7e",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_PARTNER",
        "href": "https://api.ayoune.app/marketing/partners/6a876aa5dc80e35f9099ced1/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_PARTNER",
        "href": "https://api.ayoune.app/marketing/partners/6a876aa5dc80e35f9099ced1",
        "method": "delete",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.38.0",
      "core": "2026.368.1"
    },
    "rateLimit": {
      "limit": "10000",
      "remaining": "8845",
      "reset": "1791608900",
      "resetDate": "Sat Oct 10 2026"
    },
    "responseTime": 99.686337,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpoints

MethodPathDescriptionRight
GET /partners List with filters/pagination marketing.partners.view
GET /partners/:id Single record marketing.partners.view
POST /partners Create new record marketing.partners.new
PUT /partners Update record marketing.partners.edit
DELETE /partners/:id Delete record marketing.partners.delete

SDK

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

// List all
const list = await ay.marketing.partners.find().limit(10).exec();

// Single record
const one = await ay.marketing.partners.findById('OBJECT_ID').exec();

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

See also