aYOUne
← CRM API

Notifications

Singular: Notification — Base URL: https://crm-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": {
    "sensitivity": "work",
    "_id": "63e1090b6818a4cf6d6e6af2",
    "user": "5a76d07e2d8b3270ff6df587",
    "adminNotification": false,
    "userNotification": true,
    "markread": false,
    "icon": "info",
    "mess": "Cannot increment with non-numeric argument: {freeField_15: \"--100000.00\"}",
    "title": "aYOUne detected an error",
    "category": "notification",
    "obj": "63be8eae62b26547230f8038",
    "view": "config.middlewares.edit",
    "createdAt": "2023-02-06T14:04:59.450Z",
    "updatedAt": "2023-02-06T14:04:59.450Z"
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://crm-api.ayoune.app/notifications/63e1090b6818a4cf6d6e6af2",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "relations": [],
    "debugId": "6a62df7ed98fe96440cc91a4",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_NOTIFICATION",
        "href": "https://api.ayoune.app/crm/notifications/63e1090b6818a4cf6d6e6af2/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_NOTIFICATION",
        "href": "https://api.ayoune.app/crm/notifications/63e1090b6818a4cf6d6e6af2/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.46.1",
      "core": "2026.258.0"
    },
    "rateLimit": {
      "limit": "2500",
      "remaining": "2302",
      "reset": "1784868196",
      "resetDate": "Fri Jul 24 2026"
    },
    "responseTime": 43.956509,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpoints

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

SDK

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

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

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

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

See also