Skip to content
aYOUne
← Configuration API

MailTypes

Singular: MailType — Base URL: https://config-api.ayoune.app — Access: CRUD — Machine-readable spec (JSON · YAML)

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": "6a85dce2b0c00f8afe95a6be",
    "isGlobal": true,
    "key": "wiki",
    "label": "Wissensseiten-Versand",
    "label_en": "Knowledge page delivery",
    "description": "Versand einer Wissensseite per Mail.",
    "namespace": "business",
    "channel": "email",
    "category": "system",
    "contentDocType": "wiki",
    "layoutDocType": "wiki",
    "active": true,
    "systemLocked": true,
    "isDraft": true,
    "createdAt": "2026-08-19T16:42:10.067Z",
    "updatedAt": "2026-08-19T16:42:10.067Z",
    "shares": []
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://config-api.ayoune.app/mailtypes/6a85dce2b0c00f8afe95a6be",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "relations": [
      {
        "rel": "EMailTemplates",
        "title": "MODEL_EMAILTEMPLATE",
        "href": "https://api.ayoune.app/config/emailtemplates",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.emailtemplates"
      }
    ],
    "debugId": "6adec7eb62556e5404c0dec3",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_MAILTYPE",
        "href": "https://api.ayoune.app/config/mailtypes/6a85dce2b0c00f8afe95a6be/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_MAILTYPE",
        "href": "https://api.ayoune.app/config/mailtypes/6a85dce2b0c00f8afe95a6be",
        "method": "delete",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.170.1",
      "core": "2026.388.0"
    },
    "rateLimit": {
      "limit": "10000",
      "remaining": "6984",
      "reset": "1792987338",
      "resetDate": "Mon Oct 26 2026"
    },
    "responseTime": 99.694845,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpoints

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

SDK

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

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

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

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

See also