aYOUne
← Marketing API

Channels

Singular: Channel — 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": {
    "_id": "65e0b0c4121b7d48fe1587fb",
    "sharedWith": [],
    "public": true,
    "admins": [],
    "participantCount": 0,
    "maxParticipants": 10,
    "participants": [],
    "isDraft": true,
    "createdBy": "6045f4d25704710012485569",
    "invites": [],
    "members": [],
    "createdAt": "2024-02-29T16:28:52.072Z",
    "updatedAt": "2024-02-29T16:28:52.072Z",
    "shares": []
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://communication-api.ayoune.app/channels/65e0b0c4121b7d48fe1587fb",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "relations": [],
    "debugId": "6aa3732ec1da44adf17a671d",
    "errors": [],
    "actions": [],
    "version": {
      "host": "2026.18.0",
      "core": "2026.333.0"
    },
    "rateLimit": {
      "limit": "2500",
      "remaining": "2494",
      "reset": "1789100349",
      "resetDate": "Fri Sep 11 2026"
    },
    "responseTime": 1002.834841,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpoints

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

SDK

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

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

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

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

See also