aYOUne
← CRM API

Selections

Singular: Selection — 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": {
    "consumerListSettings": {
      "action": "append"
    },
    "segmentSettings": {
      "action": "none"
    },
    "pipeline": [],
    "pipelineModel": "Consumers",
    "pipelineVersion": 0,
    "executionCount": 0,
    "_lastRunResults": [],
    "_id": "65e0b0ac121b7d48fe158585",
    "automate": false,
    "interval": 1,
    "intervalUnit": "hours",
    "createdBy": "6045f4d25704710012485569",
    "last_run": "2024-02-29T16:28:28.148Z",
    "createdAt": "2024-02-29T16:28:28.149Z",
    "updatedAt": "2024-02-29T16:28:28.149Z"
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://crm-api.ayoune.app/selections/65e0b0ac121b7d48fe158585",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "relations": [
      {
        "rel": "ConsumerLists",
        "title": "MODEL_CONSUMERLIST",
        "href": "https://api.ayoune.app/crm/consumerlists",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "crm.consumerlists"
      },
      {
        "rel": "Segments",
        "title": "MODEL_SEGMENT",
        "href": "https://api.ayoune.app/crm/segments",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "crm.segments"
      }
    ],
    "debugId": "6a62df88d98fe96440cc9581",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_SELECTION",
        "href": "https://api.ayoune.app/crm/selections/65e0b0ac121b7d48fe158585/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_SELECTION",
        "href": "https://api.ayoune.app/crm/selections/65e0b0ac121b7d48fe158585/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.46.1",
      "core": "2026.258.0"
    },
    "rateLimit": {
      "limit": "2500",
      "remaining": "2241",
      "reset": "1784868196",
      "resetDate": "Fri Jul 24 2026"
    },
    "responseTime": 102.819838,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpoints

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

SDK

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

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

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

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

See also