aYOUne
← Marketing API

BeaconZones

Singular: BeaconZone — Base URL: https://marketing-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": "65e074ec7631a977e1babd08",
    "createdBy": "6045f4d25704710012485569",
    "createdAt": "2024-02-29T12:13:32.145Z",
    "updatedAt": "2024-02-29T12:13:32.145Z"
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://marketing-api.ayoune.app/beaconzones/65e074ec7631a977e1babd08",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "relations": [],
    "debugId": "6a61944ef78ad61f1990d0ba",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_BEACONZONE",
        "href": "https://api.ayoune.app/marketing/beaconzones/65e074ec7631a977e1babd08/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_BEACONZONE",
        "href": "https://api.ayoune.app/marketing/beaconzones/65e074ec7631a977e1babd08/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.24.4",
      "core": "2026.257.1"
    },
    "rateLimit": {
      "limit": "2500",
      "remaining": "2423",
      "reset": "1784783437",
      "resetDate": "Thu Jul 23 2026"
    },
    "responseTime": 100.437618,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpoints

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

SDK

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

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

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

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

See also