aYOUne
← Marketing API

Coupons

Singular: Coupon — 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": "65e078f711cb6213d99d02ef",
    "limit": 1,
    "type": "fix",
    "used": 0,
    "min_revenue": 0,
    "createdBy": "6045f4d25704710012485569",
    "createdAt": "2024-02-29T12:30:47.007Z",
    "updatedAt": "2024-02-29T12:30:47.007Z",
    "coupon": "9sWVdWi"
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://marketing-api.ayoune.app/coupons/65e078f711cb6213d99d02ef",
        "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"
      },
      {
        "rel": "LoyaltyPrograms",
        "title": "MODEL_LOYALTYPROGRAM",
        "href": "https://api.ayoune.app/marketing/loyaltyprograms",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "marketing.loyaltyprograms"
      },
      {
        "rel": "Intermediaries",
        "title": "MODEL_INTERMEDIARY",
        "href": "https://api.ayoune.app/config/intermediaries",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.intermediaries"
      }
    ],
    "debugId": "6a619470f78ad61f1990dc97",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_COUPON",
        "href": "https://api.ayoune.app/marketing/coupons/65e078f711cb6213d99d02ef/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_COUPON",
        "href": "https://api.ayoune.app/marketing/coupons/65e078f711cb6213d99d02ef/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.24.4",
      "core": "2026.257.1"
    },
    "rateLimit": {
      "limit": "2500",
      "remaining": "2242",
      "reset": "1784783437",
      "resetDate": "Thu Jul 23 2026"
    },
    "responseTime": 99.399218,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpoints

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

SDK

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

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

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

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

See also