aYOUne
← Marketing API

UCDs

Singular: UCD — Base URL: https://marketing-api.ayoune.app — Access: CRUD

play_circle 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": {
    "h1": {
      "desktop": "",
      "tablet": "",
      "phone": ""
    },
    "h2": {
      "desktop": "",
      "tablet": "",
      "phone": ""
    },
    "h3": {
      "desktop": "",
      "tablet": "",
      "phone": ""
    },
    "h4": {
      "desktop": "",
      "tablet": "",
      "phone": ""
    },
    "h5": {
      "desktop": "",
      "tablet": "",
      "phone": ""
    },
    "h6": {
      "desktop": "",
      "tablet": "",
      "phone": ""
    },
    "ayoune_cta_btn1": {
      "desktop": "",
      "tablet": "",
      "phone": ""
    },
    "ayoune_cta_btn2": {
      "desktop": "",
      "tablet": "",
      "phone": ""
    },
    "ayoune_cta1": {
      "desktop": "",
      "tablet": "",
      "phone": ""
    },
    "ayoune_cta2": {
      "desktop": "",
      "tablet": "",
      "phone": ""
    },
    "ayoune_cta3": {
      "desktop": "",
      "tablet": "",
      "phone": ""
    },
    "ayoune_cta4": {
      "desktop": "",
      "tablet": "",
      "phone": ""
    },
    "ayoune_main_content": {
      "desktop": "",
      "tablet": "",
      "phone": ""
    },
    "_id": "65e0b14b121b7d48fe15943c",
    "createdBy": "6045f4d25704710012485569",
    "createdAt": "2024-02-29T16:31:07.860Z",
    "updatedAt": "2024-02-29T16:31:07.860Z"
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://marketing-api.ayoune.app/ucds/65e0b14b121b7d48fe15943c",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "relations": [],
    "debugId": "6a6194c4f78ad61f1990fe36",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_UCD",
        "href": "https://api.ayoune.app/marketing/ucds/65e0b14b121b7d48fe15943c/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_UCD",
        "href": "https://api.ayoune.app/marketing/ucds/65e0b14b121b7d48fe15943c/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.24.4",
      "core": "2026.257.1"
    },
    "rateLimit": {
      "limit": "2500",
      "remaining": "1758",
      "reset": "1784783437",
      "resetDate": "Thu Jul 23 2026"
    },
    "responseTime": 20.652129,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpoints

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

SDK

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

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

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

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

See also