aYOUne
← Marketing API

UserLinks

Singular: UserLink — Base URL: https://marketing-api.ayoune.app — Access: CRUD

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": "65e0b14f121b7d48fe15948a",
    "target": "",
    "ltarget": "",
    "createdBy": "6045f4d25704710012485569",
    "createdAt": "2024-02-29T16:31:11.733Z",
    "updatedAt": "2024-02-29T16:31:11.733Z"
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://marketing-api.ayoune.app/userlinks/65e0b14f121b7d48fe15948a",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "relations": [
      {
        "rel": "Consumers",
        "title": "MODEL_CONSUMER",
        "href": "https://api.ayoune.app/crm/consumers",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "crm.consumers"
      }
    ],
    "debugId": "6a6194c9f78ad61f1991008b",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_USERLINK",
        "href": "https://api.ayoune.app/marketing/userlinks/65e0b14f121b7d48fe15948a/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_USERLINK",
        "href": "https://api.ayoune.app/marketing/userlinks/65e0b14f121b7d48fe15948a/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.24.4",
      "core": "2026.257.1"
    },
    "rateLimit": {
      "limit": "2500",
      "remaining": "1725",
      "reset": "1784783437",
      "resetDate": "Thu Jul 23 2026"
    },
    "responseTime": 17.11719,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpoints

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

SDK

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

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

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

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

See also