aYOUne
← Marketing API

PopUps

Singular: PopUp — 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": {
    "_id": "65e0b13c121b7d48fe1592dd",
    "type": "classic",
    "variation": "A",
    "variations": [],
    "interest": "-",
    "region": "-",
    "plz": "-",
    "h1": "Überschrift",
    "icon_before": "fa-arrow-right",
    "button_txt": "Jetzt downloaden",
    "icon_after": "fa-arrow-left",
    "background_color_1": "#FFFFFF",
    "background_color_2": "#FFFFFF",
    "border_color": "#000000",
    "button_border_color": "#000000",
    "button_text_color": "#000000",
    "border_radius_top_left": 0,
    "border_radius_top_right": 0,
    "border_radius_bottom_left": 0,
    "border_radius_bottom_right": 0,
    "font_color": "#000000",
    "use_btn": true,
    "button_color_1": "#FF0000",
    "button_color_2": "#FF0000",
    "font_size_t1": 10,
    "font_size_t2": 10,
    "font_size_t3": 10,
    "font_size_btn": 10,
    "font_type": "Arial",
    "width": 350,
    "height": 300,
    "show_border": 0,
    "locale": "de_DE",
    "createdBy": "6045f4d25704710012485569",
    "createdAt": "2024-02-29T16:30:52.814Z",
    "updatedAt": "2024-02-29T16:30:52.814Z"
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://marketing-api.ayoune.app/popups/65e0b13c121b7d48fe1592dd",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "relations": [],
    "debugId": "6a6194aef78ad61f1990f503",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_POPUP",
        "href": "https://api.ayoune.app/marketing/popups/65e0b13c121b7d48fe1592dd/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_POPUP",
        "href": "https://api.ayoune.app/marketing/popups/65e0b13c121b7d48fe1592dd/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.24.4",
      "core": "2026.257.1"
    },
    "rateLimit": {
      "limit": "2500",
      "remaining": "1889",
      "reset": "1784783437",
      "resetDate": "Thu Jul 23 2026"
    },
    "responseTime": 70.080878,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpoints

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

SDK

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

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

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

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

See also