aYOUne
← Marketing API

CommunicationWidgets

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

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": {
    "style": {
      "formAppearance": "outline",
      "background_color": "#FFFFFF",
      "border_radius": 0,
      "font_color": "#eeeeee",
      "button_color": "#14444C",
      "font_size": 10,
      "font_type": "Arial"
    },
    "_id": "65e0752c7631a977e1babf6c",
    "type": "click-to-call",
    "title": "Vergib einen Titel",
    "button_txt": "Rückruf anfordern",
    "agents": [],
    "products": [],
    "locale": "de_DE",
    "isDraft": true,
    "createdBy": "6045f4d25704710012485569",
    "createdAt": "2024-02-29T12:14:36.819Z",
    "updatedAt": "2024-02-29T12:14:36.819Z",
    "shares": []
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://marketing-api.ayoune.app/communicationwidgets/65e0752c7631a977e1babf6c",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "relations": [
      {
        "rel": "Affiliates",
        "title": "MODEL_AFFILIATE",
        "href": "https://api.ayoune.app/config/affiliates",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.affiliates"
      }
    ],
    "debugId": "6aa37db9e7af9185f0f6d485",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_COMMUNICATIONWIDGET",
        "href": "https://api.ayoune.app/marketing/communicationwidgets/65e0752c7631a977e1babf6c/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_COMMUNICATIONWIDGET",
        "href": "https://api.ayoune.app/marketing/communicationwidgets/65e0752c7631a977e1babf6c",
        "method": "delete",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.38.0",
      "core": "2026.334.1"
    },
    "rateLimit": {
      "limit": "2500",
      "remaining": "2265",
      "reset": "1789102955",
      "resetDate": "Fri Sep 11 2026"
    },
    "responseTime": 87.115518,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpoints

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

SDK

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

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

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

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

See also