aYOUne
← planning API

BenchmarkOptIns

Singular: BenchmarkOptIn — Base URL: https://planning-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": {
    "_id": "6a61983f3b41dde1f134e885",
    "createdBy": "6045f4d25704710012485569",
    "createdAt": "2026-07-23T04:27:43.462Z",
    "updatedAt": "2026-07-23T04:27:43.462Z"
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://planning-api.ayoune.app/benchmarkoptins/6a61983f3b41dde1f134e885",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "relations": [
      {
        "rel": "Industries",
        "title": "MODEL_INDUSTRY",
        "href": "https://api.ayoune.app/config/industries",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.industries"
      }
    ],
    "debugId": "6a61983f3b41dde1f134e8b3",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_BENCHMARKOPTIN",
        "href": "https://api.ayoune.app/planning/benchmarkoptins/6a61983f3b41dde1f134e885/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_BENCHMARKOPTIN",
        "href": "https://api.ayoune.app/planning/benchmarkoptins/6a61983f3b41dde1f134e885/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.20.0",
      "core": "2026.257.1"
    },
    "rateLimit": {
      "limit": "2500",
      "remaining": "2385",
      "reset": "1784784442",
      "resetDate": "Thu Jul 23 2026"
    },
    "responseTime": 58.515196,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpoints

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

SDK

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

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

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

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

See also