aYOUne
← Marketing API

ChatWidgets

Singular: ChatWidget — 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": {
    "config": {
      "identify": {
        "enabled": false,
        "requireBeforeChat": false,
        "fields": []
      }
    },
    "knowledgeBase": {
      "suggestedArticles": [],
      "knowledgeBases": []
    },
    "articles": {
      "sources": []
    },
    "_id": "65e074f57631a977e1babe55",
    "users": [],
    "createdBy": "6045f4d25704710012485569",
    "createdAt": "2024-02-29T12:13:41.691Z",
    "updatedAt": "2024-02-29T12:13:41.691Z"
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://marketing-api.ayoune.app/chatwidgets/65e074f57631a977e1babe55",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "relations": [
      {
        "rel": "Bots",
        "title": "MODEL_BOT",
        "href": "https://api.ayoune.app/ai/bots",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "ai.bots"
      },
      {
        "rel": "AIAgents",
        "title": "MODEL_AIAGENT",
        "href": "https://api.ayoune.app/ai/aiagents",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "ai.aiagents"
      }
    ],
    "debugId": "6a619462f78ad61f1990d7a1",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_CHATWIDGET",
        "href": "https://api.ayoune.app/marketing/chatwidgets/65e074f57631a977e1babe55/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_CHATWIDGET",
        "href": "https://api.ayoune.app/marketing/chatwidgets/65e074f57631a977e1babe55/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.24.4",
      "core": "2026.257.1"
    },
    "rateLimit": {
      "limit": "2500",
      "remaining": "2323",
      "reset": "1784783437",
      "resetDate": "Thu Jul 23 2026"
    },
    "responseTime": 29.82569,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpoints

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

SDK

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

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

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

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

See also