POST/v2/promotion

Rabatt- oder Gutscheinkampagne anlegen

Erstellt eine campaign- oder sale-Kampagne mit Verrechnungsart, Zeitraum, Wert und Währung. validity_range und tags akzeptieren ausschließlich vorhandene öffentliche IDs des Kontos; [] legt keine Zuordnung an. Ein Objekt oder eine generische Liste von Objekten wird unterstützt; die Feldnormalisierung gilt weiterhin.

Operation-ID post_v2_promotion

Vertrag & Verhalten

Dokumentationsstand: reviewed
Ändert Zustand: Ja
Als readOnly markiert: Nein
Für Automation markiert: Nein

Authentifizierung

Eine der folgenden Alternativen muss erfüllt sein (ODER). Innerhalb jeder Alternative werden alle angegebenen Schemas gemeinsam benötigt (UND).

Alternative 1

bearerAuthhttp · bearer

Existing edoobox v2 access token. Never substitute API key/secret headers.

Format: JWT

Security-Schema als JSON

{
  "type": "http",
  "scheme": "bearer",
  "bearerFormat": "JWT",
  "description": "Existing edoobox v2 access token. Never substitute API key/secret headers."
}

accountContextapiKey

Selected login/account context from the JWT, not a database primary key. Required even for a JWT with one account.

header: edid

Security-Schema als JSON

{
  "type": "apiKey",
  "in": "header",
  "name": "edid",
  "description": "Selected login/account context from the JWT, not a database primary key. Required even for a JWT with one account."
}

Alternative 2

sessionCookieapiKey

Existing browser login session, with the same permission checks as Bearer authentication.

cookie: _edlogin

Security-Schema als JSON

{
  "type": "apiKey",
  "in": "cookie",
  "name": "_edlogin",
  "description": "Existing browser login session, with the same permission checks as Bearer authentication."
}

accountContextapiKey

Selected login/account context from the JWT, not a database primary key. Required even for a JWT with one account.

header: edid

Security-Schema als JSON

{
  "type": "apiKey",
  "in": "header",
  "name": "edid",
  "description": "Selected login/account context from the JWT, not a database primary key. Required even for a JWT with one account."
}

Berechtigungen

Resource permission mapping from APIPermissions(), Authfunc::_getCheckJWT. Additional model/admin/plugin checks may apply; resources absent from api_permission do not acquire a fictitious scope.

Ressource: promotion · prom
Levels: 2, 3, 4
Dispatcher-Prüfung: Ja

Parameter

Header

languageoptional

Account language code, where the resource supports setLanguage().

string

Schema-Beispiel

"de"

Vollständiges Schema als JSON

{
  "type": "string",
  "examples": [
    "de"
  ]
}

X-Edoobox-If-Revisionoptional

Optional account mutation revision from a preceding authenticated auth-context snapshot. The dispatcher compares it while holding the account lock; mismatch409 requires a new review.

string

pattern: "^[a-f0-9]{32}$"

Schema-Beispiel

"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

Vollständiges Schema als JSON

{
  "type": "string",
  "pattern": "^[a-f0-9]{32}$",
  "examples": [
    "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
  ]
}

Request Body

erforderlich

`application/json`

object

data Typ nicht eingeschränkt erforderlich

anyOf · Mindestens eine Variante muss passen

Variante 1 object

Source-declared fields; action-specific and account validation still apply.

minProperties: 1

id kein Wert zulässig

name Typ nicht eingeschränkt erforderlich bei Anlage erforderlich

Kanonischer Typ nach Normalisierung: string. Dies ist keine zusätzliche Einschränkung des Eingabetyps.

Maximal gespeicherte Länge: 100. Diese Speichergrenze ist keine maxLength-Validierung der Eingabe.

The aP getter trims text, replaces newlines and limits the legacy escaped storage representation to maxStoredLength UTF-8 characters without splitting escape pairs; aQ decodes the stored representation. Non-string input becomes empty text. This getter limit is normalization, not a rejecting input maxLength or proof of a custom action hook or database column capacity.

Schema-Beispiel

"Example"

Feld-Metadaten aus der Spezifikation

{
  "x-edoobox-canonicalType": "string",
  "x-edoobox-maxStoredLength": 100,
  "x-edoobox-normalization": "The aP getter trims text, replaces newlines and limits the legacy escaped storage representation to maxStoredLength UTF-8 characters without splitting escape pairs; aQ decodes the stored representation. Non-string input becomes empty text. This getter limit is normalization, not a rejecting input maxLength or proof of a custom action hook or database column capacity.",
  "x-edoobox-requiredOnCreate": true,
  "x-edoobox-sourceLine": 34
}

status Typ nicht eingeschränkt

PHP value==false ->0 else1. Canonical booleans supported; other values coerce. No strict wire bool validator. Loose false comparison. insert_default injects input0 when absent, so omitted status defaults inactive despite metadata flagtrue.

Kanonischer Typ nach Normalisierung: boolean. Dies ist keine zusätzliche Einschränkung des Eingabetyps.

2 Schema-Beispiele

true

false

Feld-Metadaten aus der Spezifikation

{
  "x-edoobox-canonicalType": "boolean",
  "x-edoobox-schemaStatus": "source-reviewed",
  "x-edoobox-contractSource": [
    {
      "file": "application/models/v2/Promotion.php",
      "line": 47,
      "lineStart": 47,
      "lineEnd": 56,
      "sha256": "ae40bd3c823c841d443c8b4b2c089c1ecd8f75d97977e7ea7fc7fc5d26d8a837",
      "spanSha256": "31b6ea0be1da051504db1496e9946546b195564680941add5f059f815bc696ca",
      "reason": "Structure getter, output setter and field flags."
    },
    {
      "file": "application/models/v2/Promotion.php",
      "line": 408,
      "lineStart": 408,
      "lineEnd": 431,
      "sha256": "ae40bd3c823c841d443c8b4b2c089c1ecd8f75d97977e7ea7fc7fc5d26d8a837",
      "spanSha256": "83a60a84e14eee2a9bc3c9e7fed5dcf05c188b7b259acb6a554a1a309a228e7b",
      "reason": "Actual resource dispatch and generic writer reachability; action branches are distinct."
    },
    {
      "file": "docs/openapi/reviews/domain-fields.json",
      "line": 1,
      "reason": "Independent field-level source review, direction applicability, examples and explicit runtime limitations.",
      "sha256": "6b38123b776600a328c8e844b0ecd6e0a579144081a345e335400dad52a9a5db"
    }
  ]
}

creation Typ nicht eingeschränkt erforderlich bei Anlage erforderlich

Switch default normalizes other input values; case labels are not an exhaustive accepted-input enum.

Schema-Beispiel

"campaign"

Feld-Metadaten aus der Spezifikation

{
  "x-edoobox-knownInputs": [
    "campaign",
    "sale"
  ],
  "x-edoobox-normalization": "Switch default normalizes other input values; case labels are not an exhaustive accepted-input enum.",
  "x-edoobox-requiredOnCreate": true,
  "x-edoobox-sourceLine": 57
}

offsetting Typ nicht eingeschränkt erforderlich bei Anlage erforderlich

Switch default normalizes other input values; case labels are not an exhaustive accepted-input enum.

Schema-Beispiel

"offer"

Feld-Metadaten aus der Spezifikation

{
  "x-edoobox-knownInputs": [
    "offer",
    "total"
  ],
  "x-edoobox-normalization": "Switch default normalizes other input values; case labels are not an exhaustive accepted-input enum.",
  "x-edoobox-requiredOnCreate": true,
  "x-edoobox-sourceLine": 81
}

date_start Typ nicht eingeschränkt erforderlich bei Anlage erforderlich

dP uses PHP strtotime(); unparseable/falsy results normalize to zero. ISO 8601 text is the canonical client input; no rejecting JSON date-time format assertion is established here. Account/action hooks may add preconditions.

Kanonischer Typ nach Normalisierung: string. Dies ist keine zusätzliche Einschränkung des Eingabetyps.

Schema-Beispiel

"2026-10-15T10:00:00+02:00"

Feld-Metadaten aus der Spezifikation

{
  "x-edoobox-canonicalType": "string",
  "x-edoobox-requiredOnCreate": true,
  "x-edoobox-sourceLine": 105
}

date_end Typ nicht eingeschränkt erforderlich bei Anlage erforderlich

Kanonischer Typ nach Normalisierung: string. Dies ist keine zusätzliche Einschränkung des Eingabetyps.

Schema-Beispiel

"2026-10-15T10:00:00+02:00"

Feld-Metadaten aus der Spezifikation

{
  "x-edoobox-canonicalType": "string",
  "x-edoobox-requiredOnCreate": true,
  "x-edoobox-sourceLine": 118
}

booking_maximum Typ nicht eingeschränkt erforderlich bei Anlage erforderlich

Kanonischer Typ nach Normalisierung: integer. Dies ist keine zusätzliche Einschränkung des Eingabetyps.

PHP coercion/normalization is applied by the Structure getter; its return type is not a rejecting wire-input type restriction.

Schema-Beispiel

Feld-Metadaten aus der Spezifikation

{
  "x-edoobox-requiredOnCreate": true,
  "x-edoobox-schemaStatus": "source-inferred",
  "x-edoobox-sourceLine": 131,
  "x-edoobox-canonicalType": "integer",
  "x-edoobox-normalization": "PHP coercion/normalization is applied by the Structure getter; its return type is not a rejecting wire-input type restriction."
}

total_award Typ nicht eingeschränkt erforderlich bei Anlage erforderlich

Kanonischer Typ nach Normalisierung: number. Dies ist keine zusätzliche Einschränkung des Eingabetyps.

PHP coercion/normalization is applied by the Structure getter; its return type is not a rejecting wire-input type restriction.

Schema-Beispiel

Feld-Metadaten aus der Spezifikation

{
  "x-edoobox-requiredOnCreate": true,
  "x-edoobox-schemaStatus": "source-inferred",
  "x-edoobox-sourceLine": 147,
  "x-edoobox-canonicalType": "number",
  "x-edoobox-normalization": "PHP coercion/normalization is applied by the Structure getter; its return type is not a rejecting wire-input type restriction."
}

minimum_amount Typ nicht eingeschränkt erforderlich bei Anlage erforderlich

Kanonischer Typ nach Normalisierung: number. Dies ist keine zusätzliche Einschränkung des Eingabetyps.

PHP coercion/normalization is applied by the Structure getter; its return type is not a rejecting wire-input type restriction.

Schema-Beispiel

Feld-Metadaten aus der Spezifikation

{
  "x-edoobox-requiredOnCreate": true,
  "x-edoobox-schemaStatus": "source-inferred",
  "x-edoobox-sourceLine": 163,
  "x-edoobox-canonicalType": "number",
  "x-edoobox-normalization": "PHP coercion/normalization is applied by the Structure getter; its return type is not a rejecting wire-input type restriction."
}

bookingType Typ nicht eingeschränkt

Switch default normalizes other input values; case labels are not an exhaustive accepted-input enum.

Schema-Beispiel

"all"

Feld-Metadaten aus der Spezifikation

{
  "x-edoobox-knownInputs": [
    "all",
    "normal",
    "offerlist",
    "waitinglist"
  ],
  "x-edoobox-normalization": "Switch default normalizes other input values; case labels are not an exhaustive accepted-input enum.",
  "x-edoobox-sourceLine": 179
}

allowedDomains Typ nicht eingeschränkt

Retains strings passing email check or FILTER_VALIDATE_URL(http://+entry). Invalid entries filtered, not rejected; non-array becomes[]. Original keys retained, so sparse result can output object. Non-array ->[]. Email or prepended-http URL filter; array_filter preserves numeric/string keys, so response may be list or keyed object. Retained members are not cast: PHP filter/concatenation may coerce nonstring members during checks, but original values remain in encoded output. Scope / limitations: URL-like validation is not strict DNS domain validation; no rejecting hostname/uniqueItems rule.

Kanonischer Typ nach Normalisierung: array. Dies ist keine zusätzliche Einschränkung des Eingabetyps.

Schema-Beispiel

[
  "member@example.invalid",
  "example.invalid"
]

Feld-Metadaten aus der Spezifikation

{
  "x-edoobox-canonicalType": "array",
  "x-edoobox-canonicalItems": "string",
  "x-edoobox-schemaStatus": "source-reviewed",
  "x-edoobox-contractSource": [
    {
      "file": "application/models/v2/Promotion.php",
      "line": 199,
      "lineStart": 199,
      "lineEnd": 224,
      "sha256": "ae40bd3c823c841d443c8b4b2c089c1ecd8f75d97977e7ea7fc7fc5d26d8a837",
      "spanSha256": "0cb8eb465f78c11358b80b495bbee4a96232b89c3911d60087e8055ca58d0bcd",
      "reason": "Structure getter, output setter and field flags."
    },
    {
      "file": "application/models/v2/Promotion.php",
      "line": 408,
      "lineStart": 408,
      "lineEnd": 431,
      "sha256": "ae40bd3c823c841d443c8b4b2c089c1ecd8f75d97977e7ea7fc7fc5d26d8a837",
      "spanSha256": "83a60a84e14eee2a9bc3c9e7fed5dcf05c188b7b259acb6a554a1a309a228e7b",
      "reason": "Actual resource dispatch and generic writer reachability; action branches are distinct."
    },
    {
      "file": "docs/openapi/reviews/domain-fields.json",
      "line": 1,
      "reason": "Independent field-level source review, direction applicability, examples and explicit runtime limitations.",
      "sha256": "6b38123b776600a328c8e844b0ecd6e0a579144081a345e335400dad52a9a5db"
    }
  ]
}

tags array

Replaces include/exclude tag associations. Requires a JSON list; every typed public tag must exist in the selected account. Unknown modes and any invalid/foreign member reject before relation writes. Duplicate mode/tag pairs are normalized; [] clears.

Array-Elemente

object

tag string erforderlich

Public tag v2 ID returned for a currently existing record in the selected account; signature, resource type and account ownership are checked by the native hook.

pattern: "^tag_[a-f0-9]{12}_-?[0-9]+$"

type string erforderlich

Erlaubte Werte

"include""exclude"

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

Feld-Metadaten aus der Spezifikation

{
  "x-edoobox-contractSource": [
    {
      "file": "application/models/v2/Promotionfunc.php",
      "line": 190,
      "lineEnd": 194,
      "reason": "The tag callback validates the full replacement before reading/changing existing relations.",
      "sha256": "e3297b0b3eb11dce16d9c360da859ed2f2f6a8b0fd6a6eedb1f352b94695a7f0"
    },
    {
      "file": "application/models/v2/Promotionfunc.php",
      "line": 268,
      "lineEnd": 295,
      "reason": "Strict list and include/exclude modes, typed tag IDs and complete same-account existence check; invalid input throws ED80100 promotion_tags_invalid.",
      "sha256": "e3297b0b3eb11dce16d9c360da859ed2f2f6a8b0fd6a6eedb1f352b94695a7f0"
    },
    {
      "file": "application/models/v2/Promotion.php",
      "line": 241,
      "reason": "Response builds an array of tag/type objects, not a scalar encoded ID.",
      "sha256": "ae40bd3c823c841d443c8b4b2c089c1ecd8f75d97977e7ea7fc7fc5d26d8a837"
    }
  ]
}

currency Typ nicht eingeschränkt erforderlich bei Anlage erforderlich beim Ändern nicht schreibbar

Kanonischer Typ nach Normalisierung: string. Dies ist keine zusätzliche Einschränkung des Eingabetyps.

Maximal gespeicherte Länge: 3. Diese Speichergrenze ist keine maxLength-Validierung der Eingabe.

Schema-Beispiel

"Example"

Feld-Metadaten aus der Spezifikation

{
  "x-edoobox-canonicalType": "string",
  "x-edoobox-maxStoredLength": 3,
  "x-edoobox-normalization": "The aP getter trims text, replaces newlines and limits the legacy escaped storage representation to maxStoredLength UTF-8 characters without splitting escape pairs; aQ decodes the stored representation. Non-string input becomes empty text. This getter limit is normalization, not a rejecting input maxLength or proof of a custom action hook or database column capacity.",
  "x-edoobox-writableOnUpdate": false,
  "x-edoobox-requiredOnCreate": true,
  "x-edoobox-sourceLine": 275
}

code_alias Typ nicht eingeschränkt erforderlich

Trim/delete chars outside A-Z/a-z/0-9/_/-, then aP(...,true,10). Invalid characters/excess length normalize, not reject. preg_replace removes disallowed characters; aP truncates resulting escaped string to10.

Kanonischer Typ nach Normalisierung: string. Dies ist keine zusätzliche Einschränkung des Eingabetyps.

Schema-Beispiel

"SAVE_30"

Feld-Metadaten aus der Spezifikation

{
  "x-edoobox-canonicalType": "string",
  "x-edoobox-schemaStatus": "source-reviewed",
  "x-edoobox-contractSource": [
    {
      "file": "application/models/v2/Promotion.php",
      "line": 289,
      "lineStart": 289,
      "lineEnd": 302,
      "sha256": "ae40bd3c823c841d443c8b4b2c089c1ecd8f75d97977e7ea7fc7fc5d26d8a837",
      "spanSha256": "98c33f91ed6539e507c58ca2df466b5f67601955f7ff8bc1178d92c596fb1f72",
      "reason": "Structure getter, output setter and field flags."
    },
    {
      "file": "application/helpers/edooboxhelp_helper.php",
      "line": 11560,
      "lineStart": 11560,
      "lineEnd": 11577,
      "sha256": "090d351b5bde81813c7a829bedf2f1f9f978fce5765f246989779f996198934e",
      "spanSha256": "47b45db25b5ed86673fe43c17c7d716427b0d86011b1ba918d19eebc39907fd1",
      "reason": "Actual aP normalization, no rejecting maxLength. Reviewed aP update preserves legacy encoded storage and aQ read semantics. Truncation removes a dangling final escape backslash rather than creating a broken SQL literal; it remains normalization, not a rejecting raw input maxLength."
    },
    {
      "file": "application/models/v2/Promotion.php",
      "line": 408,
      "lineStart": 408,
      "lineEnd": 431,
      "sha256": "ae40bd3c823c841d443c8b4b2c089c1ecd8f75d97977e7ea7fc7fc5d26d8a837",
      "spanSha256": "83a60a84e14eee2a9bc3c9e7fed5dcf05c188b7b259acb6a554a1a309a228e7b",
      "reason": "Actual resource dispatch and generic writer reachability; action branches are distinct."
    },
    {
      "file": "docs/openapi/reviews/domain-fields.json",
      "line": 1,
      "reason": "Independent field-level source review, direction applicability, examples and explicit runtime limitations.",
      "sha256": "6b38123b776600a328c8e844b0ecd6e0a579144081a345e335400dad52a9a5db"
    }
  ]
}

settlement Typ nicht eingeschränkt erforderlich bei Anlage erforderlich

Switch default normalizes other input values; case labels are not an exhaustive accepted-input enum.

Schema-Beispiel

"percent"

Feld-Metadaten aus der Spezifikation

{
  "x-edoobox-knownInputs": [
    "percent",
    "amount"
  ],
  "x-edoobox-normalization": "Switch default normalizes other input values; case labels are not an exhaustive accepted-input enum.",
  "x-edoobox-requiredOnCreate": true,
  "x-edoobox-sourceLine": 303
}

validity_range array

JSON list of account-owned existing offers/categories. Complete typed/resource-subtype validation happens before validity relations change; duplicate targets are normalized and [] clears the range.

Array-Elemente

string

Public offer or category v2 ID returned for an existing same-account course or folder/root2 respectively.

pattern: "^(?:offer|category)_[a-f0-9]{12}_-?[0-9]+$"

Feld-Metadaten aus der Spezifikation

{
  "x-edoobox-contractSource": [
    {
      "file": "application/models/v2/Promotionfunc.php",
      "line": 58,
      "lineEnd": 62,
      "reason": "PUT validates the full range before changing existing validity relations.",
      "sha256": "e3297b0b3eb11dce16d9c360da859ed2f2f6a8b0fd6a6eedb1f352b94695a7f0"
    },
    {
      "file": "application/models/v2/Promotionfunc.php",
      "line": 124,
      "lineEnd": 126,
      "reason": "POST relation callback uses the same validator.",
      "sha256": "e3297b0b3eb11dce16d9c360da859ed2f2f6a8b0fd6a6eedb1f352b94695a7f0"
    },
    {
      "file": "application/models/v2/Promotionfunc.php",
      "line": 150,
      "lineEnd": 180,
      "reason": "Only typed offer/category IDs, list shape and positive decoded references; same-account DB checks distinguish kurs from ordner/root2.",
      "sha256": "e3297b0b3eb11dce16d9c360da859ed2f2f6a8b0fd6a6eedb1f352b94695a7f0"
    },
    {
      "file": "application/models/v2/Promotion.php",
      "line": 343,
      "reason": "Response returns an array of public offer/category IDs.",
      "sha256": "ae40bd3c823c841d443c8b4b2c089c1ecd8f75d97977e7ea7fc7fc5d26d8a837"
    }
  ]
}

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

Variante 2 array

minItems: 1
maxItems: 100

Array-Elemente

object

Source-declared fields; action-specific and account validation still apply.

id kein Wert zulässig

name Typ nicht eingeschränkt erforderlich bei Anlage erforderlich

Kanonischer Typ nach Normalisierung: string. Dies ist keine zusätzliche Einschränkung des Eingabetyps.

Maximal gespeicherte Länge: 100. Diese Speichergrenze ist keine maxLength-Validierung der Eingabe.

Schema-Beispiel

"Example"

Feld-Metadaten aus der Spezifikation

{
  "x-edoobox-canonicalType": "string",
  "x-edoobox-maxStoredLength": 100,
  "x-edoobox-normalization": "The aP getter trims text, replaces newlines and limits the legacy escaped storage representation to maxStoredLength UTF-8 characters without splitting escape pairs; aQ decodes the stored representation. Non-string input becomes empty text. This getter limit is normalization, not a rejecting input maxLength or proof of a custom action hook or database column capacity.",
  "x-edoobox-requiredOnCreate": true,
  "x-edoobox-sourceLine": 34
}

status Typ nicht eingeschränkt

Kanonischer Typ nach Normalisierung: boolean. Dies ist keine zusätzliche Einschränkung des Eingabetyps.

2 Schema-Beispiele

true

false

Feld-Metadaten aus der Spezifikation

{
  "x-edoobox-canonicalType": "boolean",
  "x-edoobox-schemaStatus": "source-reviewed",
  "x-edoobox-contractSource": [
    {
      "file": "application/models/v2/Promotion.php",
      "line": 47,
      "lineStart": 47,
      "lineEnd": 56,
      "sha256": "ae40bd3c823c841d443c8b4b2c089c1ecd8f75d97977e7ea7fc7fc5d26d8a837",
      "spanSha256": "31b6ea0be1da051504db1496e9946546b195564680941add5f059f815bc696ca",
      "reason": "Structure getter, output setter and field flags."
    },
    {
      "file": "application/models/v2/Promotion.php",
      "line": 408,
      "lineStart": 408,
      "lineEnd": 431,
      "sha256": "ae40bd3c823c841d443c8b4b2c089c1ecd8f75d97977e7ea7fc7fc5d26d8a837",
      "spanSha256": "83a60a84e14eee2a9bc3c9e7fed5dcf05c188b7b259acb6a554a1a309a228e7b",
      "reason": "Actual resource dispatch and generic writer reachability; action branches are distinct."
    },
    {
      "file": "docs/openapi/reviews/domain-fields.json",
      "line": 1,
      "reason": "Independent field-level source review, direction applicability, examples and explicit runtime limitations.",
      "sha256": "6b38123b776600a328c8e844b0ecd6e0a579144081a345e335400dad52a9a5db"
    }
  ]
}

creation Typ nicht eingeschränkt erforderlich bei Anlage erforderlich

Switch default normalizes other input values; case labels are not an exhaustive accepted-input enum.

Schema-Beispiel

"campaign"

Feld-Metadaten aus der Spezifikation

{
  "x-edoobox-knownInputs": [
    "campaign",
    "sale"
  ],
  "x-edoobox-normalization": "Switch default normalizes other input values; case labels are not an exhaustive accepted-input enum.",
  "x-edoobox-requiredOnCreate": true,
  "x-edoobox-sourceLine": 57
}

offsetting Typ nicht eingeschränkt erforderlich bei Anlage erforderlich

Switch default normalizes other input values; case labels are not an exhaustive accepted-input enum.

Schema-Beispiel

"offer"

Feld-Metadaten aus der Spezifikation

{
  "x-edoobox-knownInputs": [
    "offer",
    "total"
  ],
  "x-edoobox-normalization": "Switch default normalizes other input values; case labels are not an exhaustive accepted-input enum.",
  "x-edoobox-requiredOnCreate": true,
  "x-edoobox-sourceLine": 81
}

date_start Typ nicht eingeschränkt erforderlich bei Anlage erforderlich

Kanonischer Typ nach Normalisierung: string. Dies ist keine zusätzliche Einschränkung des Eingabetyps.

Schema-Beispiel

"2026-10-15T10:00:00+02:00"

Feld-Metadaten aus der Spezifikation

{
  "x-edoobox-canonicalType": "string",
  "x-edoobox-requiredOnCreate": true,
  "x-edoobox-sourceLine": 105
}

date_end Typ nicht eingeschränkt erforderlich bei Anlage erforderlich

Kanonischer Typ nach Normalisierung: string. Dies ist keine zusätzliche Einschränkung des Eingabetyps.

Schema-Beispiel

"2026-10-15T10:00:00+02:00"

Feld-Metadaten aus der Spezifikation

{
  "x-edoobox-canonicalType": "string",
  "x-edoobox-requiredOnCreate": true,
  "x-edoobox-sourceLine": 118
}

booking_maximum Typ nicht eingeschränkt erforderlich bei Anlage erforderlich

Kanonischer Typ nach Normalisierung: integer. Dies ist keine zusätzliche Einschränkung des Eingabetyps.

PHP coercion/normalization is applied by the Structure getter; its return type is not a rejecting wire-input type restriction.

Schema-Beispiel

Feld-Metadaten aus der Spezifikation

{
  "x-edoobox-requiredOnCreate": true,
  "x-edoobox-schemaStatus": "source-inferred",
  "x-edoobox-sourceLine": 131,
  "x-edoobox-canonicalType": "integer",
  "x-edoobox-normalization": "PHP coercion/normalization is applied by the Structure getter; its return type is not a rejecting wire-input type restriction."
}

total_award Typ nicht eingeschränkt erforderlich bei Anlage erforderlich

Kanonischer Typ nach Normalisierung: number. Dies ist keine zusätzliche Einschränkung des Eingabetyps.

PHP coercion/normalization is applied by the Structure getter; its return type is not a rejecting wire-input type restriction.

Schema-Beispiel

Feld-Metadaten aus der Spezifikation

{
  "x-edoobox-requiredOnCreate": true,
  "x-edoobox-schemaStatus": "source-inferred",
  "x-edoobox-sourceLine": 147,
  "x-edoobox-canonicalType": "number",
  "x-edoobox-normalization": "PHP coercion/normalization is applied by the Structure getter; its return type is not a rejecting wire-input type restriction."
}

minimum_amount Typ nicht eingeschränkt erforderlich bei Anlage erforderlich

Kanonischer Typ nach Normalisierung: number. Dies ist keine zusätzliche Einschränkung des Eingabetyps.

PHP coercion/normalization is applied by the Structure getter; its return type is not a rejecting wire-input type restriction.

Schema-Beispiel

Feld-Metadaten aus der Spezifikation

{
  "x-edoobox-requiredOnCreate": true,
  "x-edoobox-schemaStatus": "source-inferred",
  "x-edoobox-sourceLine": 163,
  "x-edoobox-canonicalType": "number",
  "x-edoobox-normalization": "PHP coercion/normalization is applied by the Structure getter; its return type is not a rejecting wire-input type restriction."
}

bookingType Typ nicht eingeschränkt

Switch default normalizes other input values; case labels are not an exhaustive accepted-input enum.

Schema-Beispiel

"all"

Feld-Metadaten aus der Spezifikation

{
  "x-edoobox-knownInputs": [
    "all",
    "normal",
    "offerlist",
    "waitinglist"
  ],
  "x-edoobox-normalization": "Switch default normalizes other input values; case labels are not an exhaustive accepted-input enum.",
  "x-edoobox-sourceLine": 179
}

allowedDomains Typ nicht eingeschränkt

Kanonischer Typ nach Normalisierung: array. Dies ist keine zusätzliche Einschränkung des Eingabetyps.

Schema-Beispiel

[
  "member@example.invalid",
  "example.invalid"
]

Feld-Metadaten aus der Spezifikation

{
  "x-edoobox-canonicalType": "array",
  "x-edoobox-canonicalItems": "string",
  "x-edoobox-schemaStatus": "source-reviewed",
  "x-edoobox-contractSource": [
    {
      "file": "application/models/v2/Promotion.php",
      "line": 199,
      "lineStart": 199,
      "lineEnd": 224,
      "sha256": "ae40bd3c823c841d443c8b4b2c089c1ecd8f75d97977e7ea7fc7fc5d26d8a837",
      "spanSha256": "0cb8eb465f78c11358b80b495bbee4a96232b89c3911d60087e8055ca58d0bcd",
      "reason": "Structure getter, output setter and field flags."
    },
    {
      "file": "application/models/v2/Promotion.php",
      "line": 408,
      "lineStart": 408,
      "lineEnd": 431,
      "sha256": "ae40bd3c823c841d443c8b4b2c089c1ecd8f75d97977e7ea7fc7fc5d26d8a837",
      "spanSha256": "83a60a84e14eee2a9bc3c9e7fed5dcf05c188b7b259acb6a554a1a309a228e7b",
      "reason": "Actual resource dispatch and generic writer reachability; action branches are distinct."
    },
    {
      "file": "docs/openapi/reviews/domain-fields.json",
      "line": 1,
      "reason": "Independent field-level source review, direction applicability, examples and explicit runtime limitations.",
      "sha256": "6b38123b776600a328c8e844b0ecd6e0a579144081a345e335400dad52a9a5db"
    }
  ]
}

tags array

Array-Elemente

object

tag string erforderlich

Public tag v2 ID returned for a currently existing record in the selected account; signature, resource type and account ownership are checked by the native hook.

pattern: "^tag_[a-f0-9]{12}_-?[0-9]+$"

type string erforderlich

Erlaubte Werte

"include""exclude"

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

Feld-Metadaten aus der Spezifikation

{
  "x-edoobox-contractSource": [
    {
      "file": "application/models/v2/Promotionfunc.php",
      "line": 190,
      "lineEnd": 194,
      "reason": "The tag callback validates the full replacement before reading/changing existing relations.",
      "sha256": "e3297b0b3eb11dce16d9c360da859ed2f2f6a8b0fd6a6eedb1f352b94695a7f0"
    },
    {
      "file": "application/models/v2/Promotionfunc.php",
      "line": 268,
      "lineEnd": 295,
      "reason": "Strict list and include/exclude modes, typed tag IDs and complete same-account existence check; invalid input throws ED80100 promotion_tags_invalid.",
      "sha256": "e3297b0b3eb11dce16d9c360da859ed2f2f6a8b0fd6a6eedb1f352b94695a7f0"
    },
    {
      "file": "application/models/v2/Promotion.php",
      "line": 241,
      "reason": "Response builds an array of tag/type objects, not a scalar encoded ID.",
      "sha256": "ae40bd3c823c841d443c8b4b2c089c1ecd8f75d97977e7ea7fc7fc5d26d8a837"
    }
  ]
}

currency Typ nicht eingeschränkt erforderlich bei Anlage erforderlich beim Ändern nicht schreibbar

Kanonischer Typ nach Normalisierung: string. Dies ist keine zusätzliche Einschränkung des Eingabetyps.

Maximal gespeicherte Länge: 3. Diese Speichergrenze ist keine maxLength-Validierung der Eingabe.

Schema-Beispiel

"Example"

Feld-Metadaten aus der Spezifikation

{
  "x-edoobox-canonicalType": "string",
  "x-edoobox-maxStoredLength": 3,
  "x-edoobox-normalization": "The aP getter trims text, replaces newlines and limits the legacy escaped storage representation to maxStoredLength UTF-8 characters without splitting escape pairs; aQ decodes the stored representation. Non-string input becomes empty text. This getter limit is normalization, not a rejecting input maxLength or proof of a custom action hook or database column capacity.",
  "x-edoobox-writableOnUpdate": false,
  "x-edoobox-requiredOnCreate": true,
  "x-edoobox-sourceLine": 275
}

code_alias Typ nicht eingeschränkt erforderlich

Kanonischer Typ nach Normalisierung: string. Dies ist keine zusätzliche Einschränkung des Eingabetyps.

Schema-Beispiel

"SAVE_30"

Feld-Metadaten aus der Spezifikation

{
  "x-edoobox-canonicalType": "string",
  "x-edoobox-schemaStatus": "source-reviewed",
  "x-edoobox-contractSource": [
    {
      "file": "application/models/v2/Promotion.php",
      "line": 289,
      "lineStart": 289,
      "lineEnd": 302,
      "sha256": "ae40bd3c823c841d443c8b4b2c089c1ecd8f75d97977e7ea7fc7fc5d26d8a837",
      "spanSha256": "98c33f91ed6539e507c58ca2df466b5f67601955f7ff8bc1178d92c596fb1f72",
      "reason": "Structure getter, output setter and field flags."
    },
    {
      "file": "application/helpers/edooboxhelp_helper.php",
      "line": 11560,
      "lineStart": 11560,
      "lineEnd": 11577,
      "sha256": "090d351b5bde81813c7a829bedf2f1f9f978fce5765f246989779f996198934e",
      "spanSha256": "47b45db25b5ed86673fe43c17c7d716427b0d86011b1ba918d19eebc39907fd1",
      "reason": "Actual aP normalization, no rejecting maxLength. Reviewed aP update preserves legacy encoded storage and aQ read semantics. Truncation removes a dangling final escape backslash rather than creating a broken SQL literal; it remains normalization, not a rejecting raw input maxLength."
    },
    {
      "file": "application/models/v2/Promotion.php",
      "line": 408,
      "lineStart": 408,
      "lineEnd": 431,
      "sha256": "ae40bd3c823c841d443c8b4b2c089c1ecd8f75d97977e7ea7fc7fc5d26d8a837",
      "spanSha256": "83a60a84e14eee2a9bc3c9e7fed5dcf05c188b7b259acb6a554a1a309a228e7b",
      "reason": "Actual resource dispatch and generic writer reachability; action branches are distinct."
    },
    {
      "file": "docs/openapi/reviews/domain-fields.json",
      "line": 1,
      "reason": "Independent field-level source review, direction applicability, examples and explicit runtime limitations.",
      "sha256": "6b38123b776600a328c8e844b0ecd6e0a579144081a345e335400dad52a9a5db"
    }
  ]
}

settlement Typ nicht eingeschränkt erforderlich bei Anlage erforderlich

Switch default normalizes other input values; case labels are not an exhaustive accepted-input enum.

Schema-Beispiel

"percent"

Feld-Metadaten aus der Spezifikation

{
  "x-edoobox-knownInputs": [
    "percent",
    "amount"
  ],
  "x-edoobox-normalization": "Switch default normalizes other input values; case labels are not an exhaustive accepted-input enum.",
  "x-edoobox-requiredOnCreate": true,
  "x-edoobox-sourceLine": 303
}

validity_range array

JSON list of account-owned existing offers/categories. Complete typed/resource-subtype validation happens before validity relations change; duplicate targets are normalized and [] clears the range.

Array-Elemente

string

Public offer or category v2 ID returned for an existing same-account course or folder/root2 respectively.

pattern: "^(?:offer|category)_[a-f0-9]{12}_-?[0-9]+$"

Feld-Metadaten aus der Spezifikation

{
  "x-edoobox-contractSource": [
    {
      "file": "application/models/v2/Promotionfunc.php",
      "line": 58,
      "lineEnd": 62,
      "reason": "PUT validates the full range before changing existing validity relations.",
      "sha256": "e3297b0b3eb11dce16d9c360da859ed2f2f6a8b0fd6a6eedb1f352b94695a7f0"
    },
    {
      "file": "application/models/v2/Promotionfunc.php",
      "line": 124,
      "lineEnd": 126,
      "reason": "POST relation callback uses the same validator.",
      "sha256": "e3297b0b3eb11dce16d9c360da859ed2f2f6a8b0fd6a6eedb1f352b94695a7f0"
    },
    {
      "file": "application/models/v2/Promotionfunc.php",
      "line": 150,
      "lineEnd": 180,
      "reason": "Only typed offer/category IDs, list shape and positive decoded references; same-account DB checks distinguish kurs from ordner/root2.",
      "sha256": "e3297b0b3eb11dce16d9c360da859ed2f2f6a8b0fd6a6eedb1f352b94695a7f0"
    },
    {
      "file": "application/models/v2/Promotion.php",
      "line": 343,
      "reason": "Response returns an array of public offer/category IDs.",
      "sha256": "ae40bd3c823c841d443c8b4b2c089c1ecd8f75d97977e7ea7fc7fc5d26d8a837"
    }
  ]
}

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

Feld-Metadaten aus der Spezifikation

{
  "x-edoobox-readOnlyFields": [],
  "x-edoobox-clientRestriction": "The server-generated id is forbidden. insert:false fields are readOnly and tolerated for existing Vue payloads because the API skips them."
}

id string

Opaque edoobox v2 object ID returned by this account. Never send a raw database ID. The synthetic example is illustrative and is not a real record.

pattern: "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$"

Schema-Beispiel

"promotion_012345abcdef_123456"

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

Vollständiges Schema als JSON

{
  "type": "object",
  "properties": {
    "data": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "id": false,
            "name": {
              "x-edoobox-canonicalType": "string",
              "x-edoobox-maxStoredLength": 100,
              "x-edoobox-normalization": "The aP getter trims text, replaces newlines and limits the legacy escaped storage representation to maxStoredLength UTF-8 characters without splitting escape pairs; aQ decodes the stored representation. Non-string input becomes empty text. This getter limit is normalization, not a rejecting input maxLength or proof of a custom action hook or database column capacity.",
              "examples": [
                "Example"
              ],
              "x-edoobox-requiredOnCreate": true,
              "x-edoobox-sourceLine": 34
            },
            "status": {
              "x-edoobox-canonicalType": "boolean",
              "description": "PHP value==false ->0 else1. Canonical booleans supported; other values coerce. No strict wire bool validator.\n\nLoose false comparison. insert_default injects input0 when absent, so omitted status defaults inactive despite metadata flagtrue.",
              "x-edoobox-schemaStatus": "source-reviewed",
              "examples": [
                true,
                false
              ],
              "x-edoobox-contractSource": [
                {
                  "file": "application/models/v2/Promotion.php",
                  "line": 47,
                  "lineStart": 47,
                  "lineEnd": 56,
                  "sha256": "ae40bd3c823c841d443c8b4b2c089c1ecd8f75d97977e7ea7fc7fc5d26d8a837",
                  "spanSha256": "31b6ea0be1da051504db1496e9946546b195564680941add5f059f815bc696ca",
                  "reason": "Structure getter, output setter and field flags."
                },
                {
                  "file": "application/models/v2/Promotion.php",
                  "line": 408,
                  "lineStart": 408,
                  "lineEnd": 431,
                  "sha256": "ae40bd3c823c841d443c8b4b2c089c1ecd8f75d97977e7ea7fc7fc5d26d8a837",
                  "spanSha256": "83a60a84e14eee2a9bc3c9e7fed5dcf05c188b7b259acb6a554a1a309a228e7b",
                  "reason": "Actual resource dispatch and generic writer reachability; action branches are distinct."
                },
                {
                  "file": "docs/openapi/reviews/domain-fields.json",
                  "line": 1,
                  "reason": "Independent field-level source review, direction applicability, examples and explicit runtime limitations.",
                  "sha256": "6b38123b776600a328c8e844b0ecd6e0a579144081a345e335400dad52a9a5db"
                }
              ]
            },
            "creation": {
              "x-edoobox-knownInputs": [
                "campaign",
                "sale"
              ],
              "x-edoobox-normalization": "Switch default normalizes other input values; case labels are not an exhaustive accepted-input enum.",
              "examples": [
                "campaign"
              ],
              "x-edoobox-requiredOnCreate": true,
              "x-edoobox-sourceLine": 57
            },
            "offsetting": {
              "x-edoobox-knownInputs": [
                "offer",
                "total"
              ],
              "x-edoobox-normalization": "Switch default normalizes other input values; case labels are not an exhaustive accepted-input enum.",
              "examples": [
                "offer"
              ],
              "x-edoobox-requiredOnCreate": true,
              "x-edoobox-sourceLine": 81
            },
            "date_start": {
              "x-edoobox-canonicalType": "string",
              "description": "dP uses PHP strtotime(); unparseable/falsy results normalize to zero. ISO 8601 text is the canonical client input; no rejecting JSON date-time format assertion is established here. Account/action hooks may add preconditions.",
              "examples": [
                "2026-10-15T10:00:00+02:00"
              ],
              "x-edoobox-requiredOnCreate": true,
              "x-edoobox-sourceLine": 105
            },
            "date_end": {
              "x-edoobox-canonicalType": "string",
              "description": "dP uses PHP strtotime(); unparseable/falsy results normalize to zero. ISO 8601 text is the canonical client input; no rejecting JSON date-time format assertion is established here. Account/action hooks may add preconditions.",
              "examples": [
                "2026-10-15T10:00:00+02:00"
              ],
              "x-edoobox-requiredOnCreate": true,
              "x-edoobox-sourceLine": 118
            },
            "booking_maximum": {
              "x-edoobox-requiredOnCreate": true,
              "x-edoobox-schemaStatus": "source-inferred",
              "x-edoobox-sourceLine": 131,
              "x-edoobox-canonicalType": "integer",
              "x-edoobox-normalization": "PHP coercion/normalization is applied by the Structure getter; its return type is not a rejecting wire-input type restriction.",
              "examples": [
                1
              ]
            },
            "total_award": {
              "x-edoobox-requiredOnCreate": true,
              "x-edoobox-schemaStatus": "source-inferred",
              "x-edoobox-sourceLine": 147,
              "x-edoobox-canonicalType": "number",
              "x-edoobox-normalization": "PHP coercion/normalization is applied by the Structure getter; its return type is not a rejecting wire-input type restriction.",
              "examples": [
                1
              ]
            },
            "minimum_amount": {
              "x-edoobox-requiredOnCreate": true,
              "x-edoobox-schemaStatus": "source-inferred",
              "x-edoobox-sourceLine": 163,
              "x-edoobox-canonicalType": "number",
              "x-edoobox-normalization": "PHP coercion/normalization is applied by the Structure getter; its return type is not a rejecting wire-input type restriction.",
              "examples": [
                1
              ]
            },
            "bookingType": {
              "x-edoobox-knownInputs": [
                "all",
                "normal",
                "offerlist",
                "waitinglist"
              ],
              "x-edoobox-normalization": "Switch default normalizes other input values; case labels are not an exhaustive accepted-input enum.",
              "examples": [
                "all"
              ],
              "x-edoobox-sourceLine": 179
            },
            "allowedDomains": {
              "description": "Retains strings passing email check or FILTER_VALIDATE_URL(http://+entry). Invalid entries filtered, not rejected; non-array becomes[]. Original keys retained, so sparse result can output object.\n\nNon-array ->[]. Email or prepended-http URL filter; array_filter preserves numeric/string keys, so response may be list or keyed object. Retained members are not cast: PHP filter/concatenation may coerce nonstring members during checks, but original values remain in encoded output.\n\nScope / limitations: URL-like validation is not strict DNS domain validation; no rejecting hostname/uniqueItems rule.",
              "x-edoobox-canonicalType": "array",
              "x-edoobox-canonicalItems": "string",
              "x-edoobox-schemaStatus": "source-reviewed",
              "examples": [
                [
                  "member@example.invalid",
                  "example.invalid"
                ]
              ],
              "x-edoobox-contractSource": [
                {
                  "file": "application/models/v2/Promotion.php",
                  "line": 199,
                  "lineStart": 199,
                  "lineEnd": 224,
                  "sha256": "ae40bd3c823c841d443c8b4b2c089c1ecd8f75d97977e7ea7fc7fc5d26d8a837",
                  "spanSha256": "0cb8eb465f78c11358b80b495bbee4a96232b89c3911d60087e8055ca58d0bcd",
                  "reason": "Structure getter, output setter and field flags."
                },
                {
                  "file": "application/models/v2/Promotion.php",
                  "line": 408,
                  "lineStart": 408,
                  "lineEnd": 431,
                  "sha256": "ae40bd3c823c841d443c8b4b2c089c1ecd8f75d97977e7ea7fc7fc5d26d8a837",
                  "spanSha256": "83a60a84e14eee2a9bc3c9e7fed5dcf05c188b7b259acb6a554a1a309a228e7b",
                  "reason": "Actual resource dispatch and generic writer reachability; action branches are distinct."
                },
                {
                  "file": "docs/openapi/reviews/domain-fields.json",
                  "line": 1,
                  "reason": "Independent field-level source review, direction applicability, examples and explicit runtime limitations.",
                  "sha256": "6b38123b776600a328c8e844b0ecd6e0a579144081a345e335400dad52a9a5db"
                }
              ]
            },
            "tags": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "tag": {
                    "type": "string",
                    "pattern": "^tag_[a-f0-9]{12}_-?[0-9]+$",
                    "description": "Public tag v2 ID returned for a currently existing record in the selected account; signature, resource type and account ownership are checked by the native hook."
                  },
                  "type": {
                    "type": "string",
                    "enum": [
                      "include",
                      "exclude"
                    ]
                  }
                },
                "additionalProperties": true,
                "required": [
                  "tag",
                  "type"
                ]
              },
              "description": "Replaces include/exclude tag associations. Requires a JSON list; every typed public tag must exist in the selected account. Unknown modes and any invalid/foreign member reject before relation writes. Duplicate mode/tag pairs are normalized; [] clears.",
              "x-edoobox-contractSource": [
                {
                  "file": "application/models/v2/Promotionfunc.php",
                  "line": 190,
                  "lineEnd": 194,
                  "reason": "The tag callback validates the full replacement before reading/changing existing relations.",
                  "sha256": "e3297b0b3eb11dce16d9c360da859ed2f2f6a8b0fd6a6eedb1f352b94695a7f0"
                },
                {
                  "file": "application/models/v2/Promotionfunc.php",
                  "line": 268,
                  "lineEnd": 295,
                  "reason": "Strict list and include/exclude modes, typed tag IDs and complete same-account existence check; invalid input throws ED80100 promotion_tags_invalid.",
                  "sha256": "e3297b0b3eb11dce16d9c360da859ed2f2f6a8b0fd6a6eedb1f352b94695a7f0"
                },
                {
                  "file": "application/models/v2/Promotion.php",
                  "line": 241,
                  "reason": "Response builds an array of tag/type objects, not a scalar encoded ID.",
                  "sha256": "ae40bd3c823c841d443c8b4b2c089c1ecd8f75d97977e7ea7fc7fc5d26d8a837"
                }
              ]
            },
            "currency": {
              "x-edoobox-canonicalType": "string",
              "x-edoobox-maxStoredLength": 3,
              "x-edoobox-normalization": "The aP getter trims text, replaces newlines and limits the legacy escaped storage representation to maxStoredLength UTF-8 characters without splitting escape pairs; aQ decodes the stored representation. Non-string input becomes empty text. This getter limit is normalization, not a rejecting input maxLength or proof of a custom action hook or database column capacity.",
              "examples": [
                "Example"
              ],
              "x-edoobox-writableOnUpdate": false,
              "x-edoobox-requiredOnCreate": true,
              "x-edoobox-sourceLine": 275
            },
            "code_alias": {
              "x-edoobox-canonicalType": "string",
              "description": "Trim/delete chars outside A-Z/a-z/0-9/_/-, then aP(...,true,10). Invalid characters/excess length normalize, not reject.\n\npreg_replace removes disallowed characters; aP truncates resulting escaped string to10.",
              "x-edoobox-schemaStatus": "source-reviewed",
              "examples": [
                "SAVE_30"
              ],
              "x-edoobox-contractSource": [
                {
                  "file": "application/models/v2/Promotion.php",
                  "line": 289,
                  "lineStart": 289,
                  "lineEnd": 302,
                  "sha256": "ae40bd3c823c841d443c8b4b2c089c1ecd8f75d97977e7ea7fc7fc5d26d8a837",
                  "spanSha256": "98c33f91ed6539e507c58ca2df466b5f67601955f7ff8bc1178d92c596fb1f72",
                  "reason": "Structure getter, output setter and field flags."
                },
                {
                  "file": "application/helpers/edooboxhelp_helper.php",
                  "line": 11560,
                  "lineStart": 11560,
                  "lineEnd": 11577,
                  "sha256": "090d351b5bde81813c7a829bedf2f1f9f978fce5765f246989779f996198934e",
                  "spanSha256": "47b45db25b5ed86673fe43c17c7d716427b0d86011b1ba918d19eebc39907fd1",
                  "reason": "Actual aP normalization, no rejecting maxLength. Reviewed aP update preserves legacy encoded storage and aQ read semantics. Truncation removes a dangling final escape backslash rather than creating a broken SQL literal; it remains normalization, not a rejecting raw input maxLength."
                },
                {
                  "file": "application/models/v2/Promotion.php",
                  "line": 408,
                  "lineStart": 408,
                  "lineEnd": 431,
                  "sha256": "ae40bd3c823c841d443c8b4b2c089c1ecd8f75d97977e7ea7fc7fc5d26d8a837",
                  "spanSha256": "83a60a84e14eee2a9bc3c9e7fed5dcf05c188b7b259acb6a554a1a309a228e7b",
                  "reason": "Actual resource dispatch and generic writer reachability; action branches are distinct."
                },
                {
                  "file": "docs/openapi/reviews/domain-fields.json",
                  "line": 1,
                  "reason": "Independent field-level source review, direction applicability, examples and explicit runtime limitations.",
                  "sha256": "6b38123b776600a328c8e844b0ecd6e0a579144081a345e335400dad52a9a5db"
                }
              ]
            },
            "settlement": {
              "x-edoobox-knownInputs": [
                "percent",
                "amount"
              ],
              "x-edoobox-normalization": "Switch default normalizes other input values; case labels are not an exhaustive accepted-input enum.",
              "examples": [
                "percent"
              ],
              "x-edoobox-requiredOnCreate": true,
              "x-edoobox-sourceLine": 303
            },
            "validity_range": {
              "type": "array",
              "items": {
                "type": "string",
                "pattern": "^(?:offer|category)_[a-f0-9]{12}_-?[0-9]+$",
                "description": "Public offer or category v2 ID returned for an existing same-account course or folder/root2 respectively."
              },
              "description": "JSON list of account-owned existing offers/categories. Complete typed/resource-subtype validation happens before validity relations change; duplicate targets are normalized and [] clears the range.",
              "x-edoobox-contractSource": [
                {
                  "file": "application/models/v2/Promotionfunc.php",
                  "line": 58,
                  "lineEnd": 62,
                  "reason": "PUT validates the full range before changing existing validity relations.",
                  "sha256": "e3297b0b3eb11dce16d9c360da859ed2f2f6a8b0fd6a6eedb1f352b94695a7f0"
                },
                {
                  "file": "application/models/v2/Promotionfunc.php",
                  "line": 124,
                  "lineEnd": 126,
                  "reason": "POST relation callback uses the same validator.",
                  "sha256": "e3297b0b3eb11dce16d9c360da859ed2f2f6a8b0fd6a6eedb1f352b94695a7f0"
                },
                {
                  "file": "application/models/v2/Promotionfunc.php",
                  "line": 150,
                  "lineEnd": 180,
                  "reason": "Only typed offer/category IDs, list shape and positive decoded references; same-account DB checks distinguish kurs from ordner/root2.",
                  "sha256": "e3297b0b3eb11dce16d9c360da859ed2f2f6a8b0fd6a6eedb1f352b94695a7f0"
                },
                {
                  "file": "application/models/v2/Promotion.php",
                  "line": 343,
                  "reason": "Response returns an array of public offer/category IDs.",
                  "sha256": "ae40bd3c823c841d443c8b4b2c089c1ecd8f75d97977e7ea7fc7fc5d26d8a837"
                }
              ]
            }
          },
          "additionalProperties": true,
          "description": "Source-declared fields; action-specific and account validation still apply.",
          "required": [
            "name",
            "creation",
            "offsetting",
            "date_start",
            "date_end",
            "booking_maximum",
            "total_award",
            "minimum_amount",
            "currency",
            "code_alias",
            "settlement"
          ],
          "minProperties": 1
        },
        {
          "type": "array",
          "minItems": 1,
          "maxItems": 100,
          "items": {
            "type": "object",
            "properties": {
              "id": false,
              "name": {
                "x-edoobox-canonicalType": "string",
                "x-edoobox-maxStoredLength": 100,
                "x-edoobox-normalization": "The aP getter trims text, replaces newlines and limits the legacy escaped storage representation to maxStoredLength UTF-8 characters without splitting escape pairs; aQ decodes the stored representation. Non-string input becomes empty text. This getter limit is normalization, not a rejecting input maxLength or proof of a custom action hook or database column capacity.",
                "examples": [
                  "Example"
                ],
                "x-edoobox-requiredOnCreate": true,
                "x-edoobox-sourceLine": 34
              },
              "status": {
                "x-edoobox-canonicalType": "boolean",
                "description": "PHP value==false ->0 else1. Canonical booleans supported; other values coerce. No strict wire bool validator.\n\nLoose false comparison. insert_default injects input0 when absent, so omitted status defaults inactive despite metadata flagtrue.",
                "x-edoobox-schemaStatus": "source-reviewed",
                "examples": [
                  true,
                  false
                ],
                "x-edoobox-contractSource": [
                  {
                    "file": "application/models/v2/Promotion.php",
                    "line": 47,
                    "lineStart": 47,
                    "lineEnd": 56,
                    "sha256": "ae40bd3c823c841d443c8b4b2c089c1ecd8f75d97977e7ea7fc7fc5d26d8a837",
                    "spanSha256": "31b6ea0be1da051504db1496e9946546b195564680941add5f059f815bc696ca",
                    "reason": "Structure getter, output setter and field flags."
                  },
                  {
                    "file": "application/models/v2/Promotion.php",
                    "line": 408,
                    "lineStart": 408,
                    "lineEnd": 431,
                    "sha256": "ae40bd3c823c841d443c8b4b2c089c1ecd8f75d97977e7ea7fc7fc5d26d8a837",
                    "spanSha256": "83a60a84e14eee2a9bc3c9e7fed5dcf05c188b7b259acb6a554a1a309a228e7b",
                    "reason": "Actual resource dispatch and generic writer reachability; action branches are distinct."
                  },
                  {
                    "file": "docs/openapi/reviews/domain-fields.json",
                    "line": 1,
                    "reason": "Independent field-level source review, direction applicability, examples and explicit runtime limitations.",
                    "sha256": "6b38123b776600a328c8e844b0ecd6e0a579144081a345e335400dad52a9a5db"
                  }
                ]
              },
              "creation": {
                "x-edoobox-knownInputs": [
                  "campaign",
                  "sale"
                ],
                "x-edoobox-normalization": "Switch default normalizes other input values; case labels are not an exhaustive accepted-input enum.",
                "examples": [
                  "campaign"
                ],
                "x-edoobox-requiredOnCreate": true,
                "x-edoobox-sourceLine": 57
              },
              "offsetting": {
                "x-edoobox-knownInputs": [
                  "offer",
                  "total"
                ],
                "x-edoobox-normalization": "Switch default normalizes other input values; case labels are not an exhaustive accepted-input enum.",
                "examples": [
                  "offer"
                ],
                "x-edoobox-requiredOnCreate": true,
                "x-edoobox-sourceLine": 81
              },
              "date_start": {
                "x-edoobox-canonicalType": "string",
                "description": "dP uses PHP strtotime(); unparseable/falsy results normalize to zero. ISO 8601 text is the canonical client input; no rejecting JSON date-time format assertion is established here. Account/action hooks may add preconditions.",
                "examples": [
                  "2026-10-15T10:00:00+02:00"
                ],
                "x-edoobox-requiredOnCreate": true,
                "x-edoobox-sourceLine": 105
              },
              "date_end": {
                "x-edoobox-canonicalType": "string",
                "description": "dP uses PHP strtotime(); unparseable/falsy results normalize to zero. ISO 8601 text is the canonical client input; no rejecting JSON date-time format assertion is established here. Account/action hooks may add preconditions.",
                "examples": [
                  "2026-10-15T10:00:00+02:00"
                ],
                "x-edoobox-requiredOnCreate": true,
                "x-edoobox-sourceLine": 118
              },
              "booking_maximum": {
                "x-edoobox-requiredOnCreate": true,
                "x-edoobox-schemaStatus": "source-inferred",
                "x-edoobox-sourceLine": 131,
                "x-edoobox-canonicalType": "integer",
                "x-edoobox-normalization": "PHP coercion/normalization is applied by the Structure getter; its return type is not a rejecting wire-input type restriction.",
                "examples": [
                  1
                ]
              },
              "total_award": {
                "x-edoobox-requiredOnCreate": true,
                "x-edoobox-schemaStatus": "source-inferred",
                "x-edoobox-sourceLine": 147,
                "x-edoobox-canonicalType": "number",
                "x-edoobox-normalization": "PHP coercion/normalization is applied by the Structure getter; its return type is not a rejecting wire-input type restriction.",
                "examples": [
                  1
                ]
              },
              "minimum_amount": {
                "x-edoobox-requiredOnCreate": true,
                "x-edoobox-schemaStatus": "source-inferred",
                "x-edoobox-sourceLine": 163,
                "x-edoobox-canonicalType": "number",
                "x-edoobox-normalization": "PHP coercion/normalization is applied by the Structure getter; its return type is not a rejecting wire-input type restriction.",
                "examples": [
                  1
                ]
              },
              "bookingType": {
                "x-edoobox-knownInputs": [
                  "all",
                  "normal",
                  "offerlist",
                  "waitinglist"
                ],
                "x-edoobox-normalization": "Switch default normalizes other input values; case labels are not an exhaustive accepted-input enum.",
                "examples": [
                  "all"
                ],
                "x-edoobox-sourceLine": 179
              },
              "allowedDomains": {
                "description": "Retains strings passing email check or FILTER_VALIDATE_URL(http://+entry). Invalid entries filtered, not rejected; non-array becomes[]. Original keys retained, so sparse result can output object.\n\nNon-array ->[]. Email or prepended-http URL filter; array_filter preserves numeric/string keys, so response may be list or keyed object. Retained members are not cast: PHP filter/concatenation may coerce nonstring members during checks, but original values remain in encoded output.\n\nScope / limitations: URL-like validation is not strict DNS domain validation; no rejecting hostname/uniqueItems rule.",
                "x-edoobox-canonicalType": "array",
                "x-edoobox-canonicalItems": "string",
                "x-edoobox-schemaStatus": "source-reviewed",
                "examples": [
                  [
                    "member@example.invalid",
                    "example.invalid"
                  ]
                ],
                "x-edoobox-contractSource": [
                  {
                    "file": "application/models/v2/Promotion.php",
                    "line": 199,
                    "lineStart": 199,
                    "lineEnd": 224,
                    "sha256": "ae40bd3c823c841d443c8b4b2c089c1ecd8f75d97977e7ea7fc7fc5d26d8a837",
                    "spanSha256": "0cb8eb465f78c11358b80b495bbee4a96232b89c3911d60087e8055ca58d0bcd",
                    "reason": "Structure getter, output setter and field flags."
                  },
                  {
                    "file": "application/models/v2/Promotion.php",
                    "line": 408,
                    "lineStart": 408,
                    "lineEnd": 431,
                    "sha256": "ae40bd3c823c841d443c8b4b2c089c1ecd8f75d97977e7ea7fc7fc5d26d8a837",
                    "spanSha256": "83a60a84e14eee2a9bc3c9e7fed5dcf05c188b7b259acb6a554a1a309a228e7b",
                    "reason": "Actual resource dispatch and generic writer reachability; action branches are distinct."
                  },
                  {
                    "file": "docs/openapi/reviews/domain-fields.json",
                    "line": 1,
                    "reason": "Independent field-level source review, direction applicability, examples and explicit runtime limitations.",
                    "sha256": "6b38123b776600a328c8e844b0ecd6e0a579144081a345e335400dad52a9a5db"
                  }
                ]
              },
              "tags": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "tag": {
                      "type": "string",
                      "pattern": "^tag_[a-f0-9]{12}_-?[0-9]+$",
                      "description": "Public tag v2 ID returned for a currently existing record in the selected account; signature, resource type and account ownership are checked by the native hook."
                    },
                    "type": {
                      "type": "string",
                      "enum": [
                        "include",
                        "exclude"
                      ]
                    }
                  },
                  "additionalProperties": true,
                  "required": [
                    "tag",
                    "type"
                  ]
                },
                "description": "Replaces include/exclude tag associations. Requires a JSON list; every typed public tag must exist in the selected account. Unknown modes and any invalid/foreign member reject before relation writes. Duplicate mode/tag pairs are normalized; [] clears.",
                "x-edoobox-contractSource": [
                  {
                    "file": "application/models/v2/Promotionfunc.php",
                    "line": 190,
                    "lineEnd": 194,
                    "reason": "The tag callback validates the full replacement before reading/changing existing relations.",
                    "sha256": "e3297b0b3eb11dce16d9c360da859ed2f2f6a8b0fd6a6eedb1f352b94695a7f0"
                  },
                  {
                    "file": "application/models/v2/Promotionfunc.php",
                    "line": 268,
                    "lineEnd": 295,
                    "reason": "Strict list and include/exclude modes, typed tag IDs and complete same-account existence check; invalid input throws ED80100 promotion_tags_invalid.",
                    "sha256": "e3297b0b3eb11dce16d9c360da859ed2f2f6a8b0fd6a6eedb1f352b94695a7f0"
                  },
                  {
                    "file": "application/models/v2/Promotion.php",
                    "line": 241,
                    "reason": "Response builds an array of tag/type objects, not a scalar encoded ID.",
                    "sha256": "ae40bd3c823c841d443c8b4b2c089c1ecd8f75d97977e7ea7fc7fc5d26d8a837"
                  }
                ]
              },
              "currency": {
                "x-edoobox-canonicalType": "string",
                "x-edoobox-maxStoredLength": 3,
                "x-edoobox-normalization": "The aP getter trims text, replaces newlines and limits the legacy escaped storage representation to maxStoredLength UTF-8 characters without splitting escape pairs; aQ decodes the stored representation. Non-string input becomes empty text. This getter limit is normalization, not a rejecting input maxLength or proof of a custom action hook or database column capacity.",
                "examples": [
                  "Example"
                ],
                "x-edoobox-writableOnUpdate": false,
                "x-edoobox-requiredOnCreate": true,
                "x-edoobox-sourceLine": 275
              },
              "code_alias": {
                "x-edoobox-canonicalType": "string",
                "description": "Trim/delete chars outside A-Z/a-z/0-9/_/-, then aP(...,true,10). Invalid characters/excess length normalize, not reject.\n\npreg_replace removes disallowed characters; aP truncates resulting escaped string to10.",
                "x-edoobox-schemaStatus": "source-reviewed",
                "examples": [
                  "SAVE_30"
                ],
                "x-edoobox-contractSource": [
                  {
                    "file": "application/models/v2/Promotion.php",
                    "line": 289,
                    "lineStart": 289,
                    "lineEnd": 302,
                    "sha256": "ae40bd3c823c841d443c8b4b2c089c1ecd8f75d97977e7ea7fc7fc5d26d8a837",
                    "spanSha256": "98c33f91ed6539e507c58ca2df466b5f67601955f7ff8bc1178d92c596fb1f72",
                    "reason": "Structure getter, output setter and field flags."
                  },
                  {
                    "file": "application/helpers/edooboxhelp_helper.php",
                    "line": 11560,
                    "lineStart": 11560,
                    "lineEnd": 11577,
                    "sha256": "090d351b5bde81813c7a829bedf2f1f9f978fce5765f246989779f996198934e",
                    "spanSha256": "47b45db25b5ed86673fe43c17c7d716427b0d86011b1ba918d19eebc39907fd1",
                    "reason": "Actual aP normalization, no rejecting maxLength. Reviewed aP update preserves legacy encoded storage and aQ read semantics. Truncation removes a dangling final escape backslash rather than creating a broken SQL literal; it remains normalization, not a rejecting raw input maxLength."
                  },
                  {
                    "file": "application/models/v2/Promotion.php",
                    "line": 408,
                    "lineStart": 408,
                    "lineEnd": 431,
                    "sha256": "ae40bd3c823c841d443c8b4b2c089c1ecd8f75d97977e7ea7fc7fc5d26d8a837",
                    "spanSha256": "83a60a84e14eee2a9bc3c9e7fed5dcf05c188b7b259acb6a554a1a309a228e7b",
                    "reason": "Actual resource dispatch and generic writer reachability; action branches are distinct."
                  },
                  {
                    "file": "docs/openapi/reviews/domain-fields.json",
                    "line": 1,
                    "reason": "Independent field-level source review, direction applicability, examples and explicit runtime limitations.",
                    "sha256": "6b38123b776600a328c8e844b0ecd6e0a579144081a345e335400dad52a9a5db"
                  }
                ]
              },
              "settlement": {
                "x-edoobox-knownInputs": [
                  "percent",
                  "amount"
                ],
                "x-edoobox-normalization": "Switch default normalizes other input values; case labels are not an exhaustive accepted-input enum.",
                "examples": [
                  "percent"
                ],
                "x-edoobox-requiredOnCreate": true,
                "x-edoobox-sourceLine": 303
              },
              "validity_range": {
                "type": "array",
                "items": {
                  "type": "string",
                  "pattern": "^(?:offer|category)_[a-f0-9]{12}_-?[0-9]+$",
                  "description": "Public offer or category v2 ID returned for an existing same-account course or folder/root2 respectively."
                },
                "description": "JSON list of account-owned existing offers/categories. Complete typed/resource-subtype validation happens before validity relations change; duplicate targets are normalized and [] clears the range.",
                "x-edoobox-contractSource": [
                  {
                    "file": "application/models/v2/Promotionfunc.php",
                    "line": 58,
                    "lineEnd": 62,
                    "reason": "PUT validates the full range before changing existing validity relations.",
                    "sha256": "e3297b0b3eb11dce16d9c360da859ed2f2f6a8b0fd6a6eedb1f352b94695a7f0"
                  },
                  {
                    "file": "application/models/v2/Promotionfunc.php",
                    "line": 124,
                    "lineEnd": 126,
                    "reason": "POST relation callback uses the same validator.",
                    "sha256": "e3297b0b3eb11dce16d9c360da859ed2f2f6a8b0fd6a6eedb1f352b94695a7f0"
                  },
                  {
                    "file": "application/models/v2/Promotionfunc.php",
                    "line": 150,
                    "lineEnd": 180,
                    "reason": "Only typed offer/category IDs, list shape and positive decoded references; same-account DB checks distinguish kurs from ordner/root2.",
                    "sha256": "e3297b0b3eb11dce16d9c360da859ed2f2f6a8b0fd6a6eedb1f352b94695a7f0"
                  },
                  {
                    "file": "application/models/v2/Promotion.php",
                    "line": 343,
                    "reason": "Response returns an array of public offer/category IDs.",
                    "sha256": "ae40bd3c823c841d443c8b4b2c089c1ecd8f75d97977e7ea7fc7fc5d26d8a837"
                  }
                ]
              }
            },
            "additionalProperties": true,
            "description": "Source-declared fields; action-specific and account validation still apply.",
            "required": [
              "name",
              "creation",
              "offsetting",
              "date_start",
              "date_end",
              "booking_maximum",
              "total_award",
              "minimum_amount",
              "currency",
              "code_alias",
              "settlement"
            ]
          }
        }
      ],
      "x-edoobox-readOnlyFields": [],
      "x-edoobox-clientRestriction": "The server-generated id is forbidden. insert:false fields are readOnly and tolerated for existing Vue payloads because the API skips them."
    },
    "id": {
      "type": "string",
      "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$",
      "description": "Opaque edoobox v2 object ID returned by this account. Never send a raw database ID. The synthetic example is illustrative and is not a real record.",
      "examples": [
        "promotion_012345abcdef_123456"
      ]
    }
  },
  "additionalProperties": true,
  "required": [
    "data"
  ]
}

Rabatt- oder Gutscheinkampagne anlegen

{
  "data": {
    "name": "Herbstaktion",
    "status": true,
    "creation": "campaign",
    "offsetting": "total",
    "date_start": "2026-11-01T00:00:00+01:00",
    "date_end": "2026-11-30T23:59:59+01:00",
    "booking_maximum": 1,
    "total_award": 10,
    "minimum_amount": 50,
    "currency": "CHF",
    "code_alias": "HERBST",
    "settlement": "percent",
    "validity_range": [
      "offer_012345abcdef_123456"
    ],
    "tags": []
  }
}

Antworten

HTTP-Status und Antwortinhalt gemeinsam auswerten. In dieser API können auch Antworten mit HTTP 200 einen Fehler enthalten.

200application/json

Generische Insert-Bestätigung mit insert und öffentlicher ID bzw. mehreren IDs bei Batch-Anlage.

Response Header

`X-Edoobox-Revision`

Rotated account revision supplied for the next action in one reviewed sequence.

string

pattern: "^[a-f0-9]{32}$"

Vollständiges Schema als JSON

{
  "type": "string",
  "pattern": "^[a-f0-9]{32}$"
}

`application/json`

object

success boolean

error boolean | string

error_code string

data Typ nicht eingeschränkt

Action-dependent data; deliberately unconstrained until a complete field contract is established.

type string

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

Vollständiges Schema als JSON

{
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "error": {
      "type": [
        "boolean",
        "string"
      ]
    },
    "error_code": {
      "type": "string"
    },
    "data": {
      "description": "Action-dependent data; deliberately unconstrained until a complete field contract is established."
    },
    "type": {
      "type": "string"
    }
  },
  "additionalProperties": true
}

Beispiel

{
  "success": true,
  "error": false,
  "data": {
    "id": "promotion_012345abcdef_123456"
  }
}

400application/json

Invalid request.

`application/json`

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel

{
  "success": false,
  "error": "ED40006"
}

401application/json

Missing/expired token, missing account context, account paused or model-specific authorization failure.

`application/json`

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel

{
  "success": false,
  "error": "ED40103"
}

402application/json

Missing/invalid action data or subscription/operation restriction.

`application/json`

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel

{
  "success": false,
  "error": "ED80100"
}

403application/json

Permission denied. Browser CORS rejection may have an empty body.

`application/json`

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel

{
  "success": false,
  "error": "ED40340"
}

404application/json

Unknown resource/action or unsupported method.

`application/json`

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel

{
  "success": false,
  "error": "ED80019"
}

409application/json

The account changed after the reviewed read. No domain operation is dispatched; obtain fresh state and review again.

`application/json`

object

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

Vollständiges Schema als JSON

{
  "type": "object",
  "additionalProperties": true
}

Beispiel

{
  "error": "ED40901",
  "error_code": "mutation_revision_conflict"
}

422application/json

Validation failed.

`application/json`

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel

{
  "success": false,
  "error": "ED80020"
}

429application/json

Request/login rate limit exceeded. Honor Retry-After when supplied; legacy rate-limit paths may omit it. Retry only proven reads within a bounded deadline; a mutation is never automatically replayed after an ambiguous response.

Response Header

`Retry-After`

Optional server delay in whole seconds or an HTTP date. Absence is not permission for an immediate retry.

string

Schema-Beispiel

"30"

Vollständiges Schema als JSON

{
  "type": "string",
  "examples": [
    "30"
  ]
}

`application/json`

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel

{
  "success": false,
  "error": "ED42902"
}

502application/json

Server-side operation failed.

`application/json`

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel

{
  "success": false,
  "error": "ED50201"
}

503application/json

The account mutation lock or revision store is unavailable. No unprotected fallback is executed.

Response Header

`application/json`

object

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

Vollständiges Schema als JSON

{
  "type": "object",
  "additionalProperties": true
}

Beispiel

{
  "error": "ED50301",
  "error_code": "mutation_revision_busy"
}

Quelle & Metadaten

Quelle laut Spezifikationapplication/models/v2/Promotion.php:408postPromotion()

Diese Angaben stammen unverändert aus der gelieferten OpenAPI-Datei. Zusätzliche Freigaben, Vorbedingungen, sensible Felder und Hinweise stehen in den Erweiterungen.

x-edoobox-mutates-state

true

x-edoobox-runtimeMutationGuard

true

x-edoobox-documentationReview

{
  "file": "docs/openapi/operation-contracts/08-subscriptions.json",
  "notes": []
}

x-edoobox-source

{
  "file": "application/models/v2/Promotion.php",
  "method": "postPromotion",
  "line": 408
}

x-edoobox-documentationStatus

"reviewed"

x-edoobox-readOnly

false

x-edoobox-safeForAutomation

false

x-edoobox-permission

{
  "resource": "promotion",
  "short": "prom",
  "checkedByDispatcher": true,
  "levels": [
    2,
    3,
    4
  ],
  "description": "Resource permission mapping from APIPermissions(), Authfunc::_getCheckJWT. Additional model/admin/plugin checks may apply; resources absent from api_permission do not acquire a fictitious scope."
}

Vollständige Operation als JSON

{
  "operationId": "post_v2_promotion",
  "summary": "Rabatt- oder Gutscheinkampagne anlegen",
  "description": "Erstellt eine campaign- oder sale-Kampagne mit Verrechnungsart, Zeitraum, Wert und Währung. validity_range und tags akzeptieren ausschließlich vorhandene öffentliche IDs des Kontos; [] legt keine Zuordnung an. Ein Objekt oder eine generische Liste von Objekten wird unterstützt; die Feldnormalisierung gilt weiterhin.",
  "tags": [
    "promotion"
  ],
  "security": [
    {
      "bearerAuth": [],
      "accountContext": []
    },
    {
      "sessionCookie": [],
      "accountContext": []
    }
  ],
  "parameters": [
    {
      "name": "language",
      "in": "header",
      "required": false,
      "description": "Account language code, where the resource supports setLanguage().",
      "schema": {
        "type": "string",
        "examples": [
          "de"
        ]
      }
    },
    {
      "name": "X-Edoobox-If-Revision",
      "in": "header",
      "required": false,
      "schema": {
        "type": "string",
        "pattern": "^[a-f0-9]{32}$",
        "examples": [
          "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
        ]
      },
      "description": "Optional account mutation revision from a preceding authenticated auth-context snapshot. The dispatcher compares it while holding the account lock; mismatch409 requires a new review."
    }
  ],
  "responses": {
    "200": {
      "description": "Generische Insert-Bestätigung mit insert und öffentlicher ID bzw. mehreren IDs bei Batch-Anlage.",
      "content": {
        "application/json": {
          "example": {
            "success": true,
            "error": false,
            "data": {
              "id": "promotion_012345abcdef_123456"
            }
          },
          "schema": {
            "type": "object",
            "properties": {
              "success": {
                "type": "boolean"
              },
              "error": {
                "type": [
                  "boolean",
                  "string"
                ]
              },
              "error_code": {
                "type": "string"
              },
              "data": {
                "description": "Action-dependent data; deliberately unconstrained until a complete field contract is established."
              },
              "type": {
                "type": "string"
              }
            },
            "additionalProperties": true
          }
        }
      },
      "headers": {
        "X-Edoobox-Revision": {
          "schema": {
            "type": "string",
            "pattern": "^[a-f0-9]{32}$"
          },
          "description": "Rotated account revision supplied for the next action in one reviewed sequence."
        }
      }
    },
    "400": {
      "description": "Invalid request.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED40006"
          }
        }
      }
    },
    "401": {
      "description": "Missing/expired token, missing account context, account paused or model-specific authorization failure.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED40103"
          }
        }
      }
    },
    "402": {
      "description": "Missing/invalid action data or subscription/operation restriction.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED80100"
          }
        }
      }
    },
    "403": {
      "description": "Permission denied. Browser CORS rejection may have an empty body.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED40340"
          }
        }
      }
    },
    "404": {
      "description": "Unknown resource/action or unsupported method.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED80019"
          }
        }
      }
    },
    "409": {
      "description": "The account changed after the reviewed read. No domain operation is dispatched; obtain fresh state and review again.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": true
          },
          "example": {
            "error": "ED40901",
            "error_code": "mutation_revision_conflict"
          }
        }
      }
    },
    "422": {
      "description": "Validation failed.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED80020"
          }
        }
      }
    },
    "429": {
      "description": "Request/login rate limit exceeded. Honor Retry-After when supplied; legacy rate-limit paths may omit it. Retry only proven reads within a bounded deadline; a mutation is never automatically replayed after an ambiguous response.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED42902"
          }
        }
      },
      "headers": {
        "Retry-After": {
          "description": "Optional server delay in whole seconds or an HTTP date. Absence is not permission for an immediate retry.",
          "schema": {
            "type": "string",
            "examples": [
              "30"
            ]
          }
        }
      }
    },
    "502": {
      "description": "Server-side operation failed.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED50201"
          }
        }
      }
    },
    "503": {
      "description": "The account mutation lock or revision store is unavailable. No unprotected fallback is executed.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "const": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": true
          },
          "example": {
            "error": "ED50301",
            "error_code": "mutation_revision_busy"
          }
        }
      }
    }
  },
  "x-edoobox-mutates-state": true,
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "properties": {
            "data": {
              "anyOf": [
                {
                  "type": "object",
                  "properties": {
                    "id": false,
                    "name": {
                      "x-edoobox-canonicalType": "string",
                      "x-edoobox-maxStoredLength": 100,
                      "x-edoobox-normalization": "The aP getter trims text, replaces newlines and limits the legacy escaped storage representation to maxStoredLength UTF-8 characters without splitting escape pairs; aQ decodes the stored representation. Non-string input becomes empty text. This getter limit is normalization, not a rejecting input maxLength or proof of a custom action hook or database column capacity.",
                      "examples": [
                        "Example"
                      ],
                      "x-edoobox-requiredOnCreate": true,
                      "x-edoobox-sourceLine": 34
                    },
                    "status": {
                      "x-edoobox-canonicalType": "boolean",
                      "description": "PHP value==false ->0 else1. Canonical booleans supported; other values coerce. No strict wire bool validator.\n\nLoose false comparison. insert_default injects input0 when absent, so omitted status defaults inactive despite metadata flagtrue.",
                      "x-edoobox-schemaStatus": "source-reviewed",
                      "examples": [
                        true,
                        false
                      ],
                      "x-edoobox-contractSource": [
                        {
                          "file": "application/models/v2/Promotion.php",
                          "line": 47,
                          "lineStart": 47,
                          "lineEnd": 56,
                          "sha256": "ae40bd3c823c841d443c8b4b2c089c1ecd8f75d97977e7ea7fc7fc5d26d8a837",
                          "spanSha256": "31b6ea0be1da051504db1496e9946546b195564680941add5f059f815bc696ca",
                          "reason": "Structure getter, output setter and field flags."
                        },
                        {
                          "file": "application/models/v2/Promotion.php",
                          "line": 408,
                          "lineStart": 408,
                          "lineEnd": 431,
                          "sha256": "ae40bd3c823c841d443c8b4b2c089c1ecd8f75d97977e7ea7fc7fc5d26d8a837",
                          "spanSha256": "83a60a84e14eee2a9bc3c9e7fed5dcf05c188b7b259acb6a554a1a309a228e7b",
                          "reason": "Actual resource dispatch and generic writer reachability; action branches are distinct."
                        },
                        {
                          "file": "docs/openapi/reviews/domain-fields.json",
                          "line": 1,
                          "reason": "Independent field-level source review, direction applicability, examples and explicit runtime limitations.",
                          "sha256": "6b38123b776600a328c8e844b0ecd6e0a579144081a345e335400dad52a9a5db"
                        }
                      ]
                    },
                    "creation": {
                      "x-edoobox-knownInputs": [
                        "campaign",
                        "sale"
                      ],
                      "x-edoobox-normalization": "Switch default normalizes other input values; case labels are not an exhaustive accepted-input enum.",
                      "examples": [
                        "campaign"
                      ],
                      "x-edoobox-requiredOnCreate": true,
                      "x-edoobox-sourceLine": 57
                    },
                    "offsetting": {
                      "x-edoobox-knownInputs": [
                        "offer",
                        "total"
                      ],
                      "x-edoobox-normalization": "Switch default normalizes other input values; case labels are not an exhaustive accepted-input enum.",
                      "examples": [
                        "offer"
                      ],
                      "x-edoobox-requiredOnCreate": true,
                      "x-edoobox-sourceLine": 81
                    },
                    "date_start": {
                      "x-edoobox-canonicalType": "string",
                      "description": "dP uses PHP strtotime(); unparseable/falsy results normalize to zero. ISO 8601 text is the canonical client input; no rejecting JSON date-time format assertion is established here. Account/action hooks may add preconditions.",
                      "examples": [
                        "2026-10-15T10:00:00+02:00"
                      ],
                      "x-edoobox-requiredOnCreate": true,
                      "x-edoobox-sourceLine": 105
                    },
                    "date_end": {
                      "x-edoobox-canonicalType": "string",
                      "description": "dP uses PHP strtotime(); unparseable/falsy results normalize to zero. ISO 8601 text is the canonical client input; no rejecting JSON date-time format assertion is established here. Account/action hooks may add preconditions.",
                      "examples": [
                        "2026-10-15T10:00:00+02:00"
                      ],
                      "x-edoobox-requiredOnCreate": true,
                      "x-edoobox-sourceLine": 118
                    },
                    "booking_maximum": {
                      "x-edoobox-requiredOnCreate": true,
                      "x-edoobox-schemaStatus": "source-inferred",
                      "x-edoobox-sourceLine": 131,
                      "x-edoobox-canonicalType": "integer",
                      "x-edoobox-normalization": "PHP coercion/normalization is applied by the Structure getter; its return type is not a rejecting wire-input type restriction.",
                      "examples": [
                        1
                      ]
                    },
                    "total_award": {
                      "x-edoobox-requiredOnCreate": true,
                      "x-edoobox-schemaStatus": "source-inferred",
                      "x-edoobox-sourceLine": 147,
                      "x-edoobox-canonicalType": "number",
                      "x-edoobox-normalization": "PHP coercion/normalization is applied by the Structure getter; its return type is not a rejecting wire-input type restriction.",
                      "examples": [
                        1
                      ]
                    },
                    "minimum_amount": {
                      "x-edoobox-requiredOnCreate": true,
                      "x-edoobox-schemaStatus": "source-inferred",
                      "x-edoobox-sourceLine": 163,
                      "x-edoobox-canonicalType": "number",
                      "x-edoobox-normalization": "PHP coercion/normalization is applied by the Structure getter; its return type is not a rejecting wire-input type restriction.",
                      "examples": [
                        1
                      ]
                    },
                    "bookingType": {
                      "x-edoobox-knownInputs": [
                        "all",
                        "normal",
                        "offerlist",
                        "waitinglist"
                      ],
                      "x-edoobox-normalization": "Switch default normalizes other input values; case labels are not an exhaustive accepted-input enum.",
                      "examples": [
                        "all"
                      ],
                      "x-edoobox-sourceLine": 179
                    },
                    "allowedDomains": {
                      "description": "Retains strings passing email check or FILTER_VALIDATE_URL(http://+entry). Invalid entries filtered, not rejected; non-array becomes[]. Original keys retained, so sparse result can output object.\n\nNon-array ->[]. Email or prepended-http URL filter; array_filter preserves numeric/string keys, so response may be list or keyed object. Retained members are not cast: PHP filter/concatenation may coerce nonstring members during checks, but original values remain in encoded output.\n\nScope / limitations: URL-like validation is not strict DNS domain validation; no rejecting hostname/uniqueItems rule.",
                      "x-edoobox-canonicalType": "array",
                      "x-edoobox-canonicalItems": "string",
                      "x-edoobox-schemaStatus": "source-reviewed",
                      "examples": [
                        [
                          "member@example.invalid",
                          "example.invalid"
                        ]
                      ],
                      "x-edoobox-contractSource": [
                        {
                          "file": "application/models/v2/Promotion.php",
                          "line": 199,
                          "lineStart": 199,
                          "lineEnd": 224,
                          "sha256": "ae40bd3c823c841d443c8b4b2c089c1ecd8f75d97977e7ea7fc7fc5d26d8a837",
                          "spanSha256": "0cb8eb465f78c11358b80b495bbee4a96232b89c3911d60087e8055ca58d0bcd",
                          "reason": "Structure getter, output setter and field flags."
                        },
                        {
                          "file": "application/models/v2/Promotion.php",
                          "line": 408,
                          "lineStart": 408,
                          "lineEnd": 431,
                          "sha256": "ae40bd3c823c841d443c8b4b2c089c1ecd8f75d97977e7ea7fc7fc5d26d8a837",
                          "spanSha256": "83a60a84e14eee2a9bc3c9e7fed5dcf05c188b7b259acb6a554a1a309a228e7b",
                          "reason": "Actual resource dispatch and generic writer reachability; action branches are distinct."
                        },
                        {
                          "file": "docs/openapi/reviews/domain-fields.json",
                          "line": 1,
                          "reason": "Independent field-level source review, direction applicability, examples and explicit runtime limitations.",
                          "sha256": "6b38123b776600a328c8e844b0ecd6e0a579144081a345e335400dad52a9a5db"
                        }
                      ]
                    },
                    "tags": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "tag": {
                            "type": "string",
                            "pattern": "^tag_[a-f0-9]{12}_-?[0-9]+$",
                            "description": "Public tag v2 ID returned for a currently existing record in the selected account; signature, resource type and account ownership are checked by the native hook."
                          },
                          "type": {
                            "type": "string",
                            "enum": [
                              "include",
                              "exclude"
                            ]
                          }
                        },
                        "additionalProperties": true,
                        "required": [
                          "tag",
                          "type"
                        ]
                      },
                      "description": "Replaces include/exclude tag associations. Requires a JSON list; every typed public tag must exist in the selected account. Unknown modes and any invalid/foreign member reject before relation writes. Duplicate mode/tag pairs are normalized; [] clears.",
                      "x-edoobox-contractSource": [
                        {
                          "file": "application/models/v2/Promotionfunc.php",
                          "line": 190,
                          "lineEnd": 194,
                          "reason": "The tag callback validates the full replacement before reading/changing existing relations.",
                          "sha256": "e3297b0b3eb11dce16d9c360da859ed2f2f6a8b0fd6a6eedb1f352b94695a7f0"
                        },
                        {
                          "file": "application/models/v2/Promotionfunc.php",
                          "line": 268,
                          "lineEnd": 295,
                          "reason": "Strict list and include/exclude modes, typed tag IDs and complete same-account existence check; invalid input throws ED80100 promotion_tags_invalid.",
                          "sha256": "e3297b0b3eb11dce16d9c360da859ed2f2f6a8b0fd6a6eedb1f352b94695a7f0"
                        },
                        {
                          "file": "application/models/v2/Promotion.php",
                          "line": 241,
                          "reason": "Response builds an array of tag/type objects, not a scalar encoded ID.",
                          "sha256": "ae40bd3c823c841d443c8b4b2c089c1ecd8f75d97977e7ea7fc7fc5d26d8a837"
                        }
                      ]
                    },
                    "currency": {
                      "x-edoobox-canonicalType": "string",
                      "x-edoobox-maxStoredLength": 3,
                      "x-edoobox-normalization": "The aP getter trims text, replaces newlines and limits the legacy escaped storage representation to maxStoredLength UTF-8 characters without splitting escape pairs; aQ decodes the stored representation. Non-string input becomes empty text. This getter limit is normalization, not a rejecting input maxLength or proof of a custom action hook or database column capacity.",
                      "examples": [
                        "Example"
                      ],
                      "x-edoobox-writableOnUpdate": false,
                      "x-edoobox-requiredOnCreate": true,
                      "x-edoobox-sourceLine": 275
                    },
                    "code_alias": {
                      "x-edoobox-canonicalType": "string",
                      "description": "Trim/delete chars outside A-Z/a-z/0-9/_/-, then aP(...,true,10). Invalid characters/excess length normalize, not reject.\n\npreg_replace removes disallowed characters; aP truncates resulting escaped string to10.",
                      "x-edoobox-schemaStatus": "source-reviewed",
                      "examples": [
                        "SAVE_30"
                      ],
                      "x-edoobox-contractSource": [
                        {
                          "file": "application/models/v2/Promotion.php",
                          "line": 289,
                          "lineStart": 289,
                          "lineEnd": 302,
                          "sha256": "ae40bd3c823c841d443c8b4b2c089c1ecd8f75d97977e7ea7fc7fc5d26d8a837",
                          "spanSha256": "98c33f91ed6539e507c58ca2df466b5f67601955f7ff8bc1178d92c596fb1f72",
                          "reason": "Structure getter, output setter and field flags."
                        },
                        {
                          "file": "application/helpers/edooboxhelp_helper.php",
                          "line": 11560,
                          "lineStart": 11560,
                          "lineEnd": 11577,
                          "sha256": "090d351b5bde81813c7a829bedf2f1f9f978fce5765f246989779f996198934e",
                          "spanSha256": "47b45db25b5ed86673fe43c17c7d716427b0d86011b1ba918d19eebc39907fd1",
                          "reason": "Actual aP normalization, no rejecting maxLength. Reviewed aP update preserves legacy encoded storage and aQ read semantics. Truncation removes a dangling final escape backslash rather than creating a broken SQL literal; it remains normalization, not a rejecting raw input maxLength."
                        },
                        {
                          "file": "application/models/v2/Promotion.php",
                          "line": 408,
                          "lineStart": 408,
                          "lineEnd": 431,
                          "sha256": "ae40bd3c823c841d443c8b4b2c089c1ecd8f75d97977e7ea7fc7fc5d26d8a837",
                          "spanSha256": "83a60a84e14eee2a9bc3c9e7fed5dcf05c188b7b259acb6a554a1a309a228e7b",
                          "reason": "Actual resource dispatch and generic writer reachability; action branches are distinct."
                        },
                        {
                          "file": "docs/openapi/reviews/domain-fields.json",
                          "line": 1,
                          "reason": "Independent field-level source review, direction applicability, examples and explicit runtime limitations.",
                          "sha256": "6b38123b776600a328c8e844b0ecd6e0a579144081a345e335400dad52a9a5db"
                        }
                      ]
                    },
                    "settlement": {
                      "x-edoobox-knownInputs": [
                        "percent",
                        "amount"
                      ],
                      "x-edoobox-normalization": "Switch default normalizes other input values; case labels are not an exhaustive accepted-input enum.",
                      "examples": [
                        "percent"
                      ],
                      "x-edoobox-requiredOnCreate": true,
                      "x-edoobox-sourceLine": 303
                    },
                    "validity_range": {
                      "type": "array",
                      "items": {
                        "type": "string",
                        "pattern": "^(?:offer|category)_[a-f0-9]{12}_-?[0-9]+$",
                        "description": "Public offer or category v2 ID returned for an existing same-account course or folder/root2 respectively."
                      },
                      "description": "JSON list of account-owned existing offers/categories. Complete typed/resource-subtype validation happens before validity relations change; duplicate targets are normalized and [] clears the range.",
                      "x-edoobox-contractSource": [
                        {
                          "file": "application/models/v2/Promotionfunc.php",
                          "line": 58,
                          "lineEnd": 62,
                          "reason": "PUT validates the full range before changing existing validity relations.",
                          "sha256": "e3297b0b3eb11dce16d9c360da859ed2f2f6a8b0fd6a6eedb1f352b94695a7f0"
                        },
                        {
                          "file": "application/models/v2/Promotionfunc.php",
                          "line": 124,
                          "lineEnd": 126,
                          "reason": "POST relation callback uses the same validator.",
                          "sha256": "e3297b0b3eb11dce16d9c360da859ed2f2f6a8b0fd6a6eedb1f352b94695a7f0"
                        },
                        {
                          "file": "application/models/v2/Promotionfunc.php",
                          "line": 150,
                          "lineEnd": 180,
                          "reason": "Only typed offer/category IDs, list shape and positive decoded references; same-account DB checks distinguish kurs from ordner/root2.",
                          "sha256": "e3297b0b3eb11dce16d9c360da859ed2f2f6a8b0fd6a6eedb1f352b94695a7f0"
                        },
                        {
                          "file": "application/models/v2/Promotion.php",
                          "line": 343,
                          "reason": "Response returns an array of public offer/category IDs.",
                          "sha256": "ae40bd3c823c841d443c8b4b2c089c1ecd8f75d97977e7ea7fc7fc5d26d8a837"
                        }
                      ]
                    }
                  },
                  "additionalProperties": true,
                  "description": "Source-declared fields; action-specific and account validation still apply.",
                  "required": [
                    "name",
                    "creation",
                    "offsetting",
                    "date_start",
                    "date_end",
                    "booking_maximum",
                    "total_award",
                    "minimum_amount",
                    "currency",
                    "code_alias",
                    "settlement"
                  ],
                  "minProperties": 1
                },
                {
                  "type": "array",
                  "minItems": 1,
                  "maxItems": 100,
                  "items": {
                    "type": "object",
                    "properties": {
                      "id": false,
                      "name": {
                        "x-edoobox-canonicalType": "string",
                        "x-edoobox-maxStoredLength": 100,
                        "x-edoobox-normalization": "The aP getter trims text, replaces newlines and limits the legacy escaped storage representation to maxStoredLength UTF-8 characters without splitting escape pairs; aQ decodes the stored representation. Non-string input becomes empty text. This getter limit is normalization, not a rejecting input maxLength or proof of a custom action hook or database column capacity.",
                        "examples": [
                          "Example"
                        ],
                        "x-edoobox-requiredOnCreate": true,
                        "x-edoobox-sourceLine": 34
                      },
                      "status": {
                        "x-edoobox-canonicalType": "boolean",
                        "description": "PHP value==false ->0 else1. Canonical booleans supported; other values coerce. No strict wire bool validator.\n\nLoose false comparison. insert_default injects input0 when absent, so omitted status defaults inactive despite metadata flagtrue.",
                        "x-edoobox-schemaStatus": "source-reviewed",
                        "examples": [
                          true,
                          false
                        ],
                        "x-edoobox-contractSource": [
                          {
                            "file": "application/models/v2/Promotion.php",
                            "line": 47,
                            "lineStart": 47,
                            "lineEnd": 56,
                            "sha256": "ae40bd3c823c841d443c8b4b2c089c1ecd8f75d97977e7ea7fc7fc5d26d8a837",
                            "spanSha256": "31b6ea0be1da051504db1496e9946546b195564680941add5f059f815bc696ca",
                            "reason": "Structure getter, output setter and field flags."
                          },
                          {
                            "file": "application/models/v2/Promotion.php",
                            "line": 408,
                            "lineStart": 408,
                            "lineEnd": 431,
                            "sha256": "ae40bd3c823c841d443c8b4b2c089c1ecd8f75d97977e7ea7fc7fc5d26d8a837",
                            "spanSha256": "83a60a84e14eee2a9bc3c9e7fed5dcf05c188b7b259acb6a554a1a309a228e7b",
                            "reason": "Actual resource dispatch and generic writer reachability; action branches are distinct."
                          },
                          {
                            "file": "docs/openapi/reviews/domain-fields.json",
                            "line": 1,
                            "reason": "Independent field-level source review, direction applicability, examples and explicit runtime limitations.",
                            "sha256": "6b38123b776600a328c8e844b0ecd6e0a579144081a345e335400dad52a9a5db"
                          }
                        ]
                      },
                      "creation": {
                        "x-edoobox-knownInputs": [
                          "campaign",
                          "sale"
                        ],
                        "x-edoobox-normalization": "Switch default normalizes other input values; case labels are not an exhaustive accepted-input enum.",
                        "examples": [
                          "campaign"
                        ],
                        "x-edoobox-requiredOnCreate": true,
                        "x-edoobox-sourceLine": 57
                      },
                      "offsetting": {
                        "x-edoobox-knownInputs": [
                          "offer",
                          "total"
                        ],
                        "x-edoobox-normalization": "Switch default normalizes other input values; case labels are not an exhaustive accepted-input enum.",
                        "examples": [
                          "offer"
                        ],
                        "x-edoobox-requiredOnCreate": true,
                        "x-edoobox-sourceLine": 81
                      },
                      "date_start": {
                        "x-edoobox-canonicalType": "string",
                        "description": "dP uses PHP strtotime(); unparseable/falsy results normalize to zero. ISO 8601 text is the canonical client input; no rejecting JSON date-time format assertion is established here. Account/action hooks may add preconditions.",
                        "examples": [
                          "2026-10-15T10:00:00+02:00"
                        ],
                        "x-edoobox-requiredOnCreate": true,
                        "x-edoobox-sourceLine": 105
                      },
                      "date_end": {
                        "x-edoobox-canonicalType": "string",
                        "description": "dP uses PHP strtotime(); unparseable/falsy results normalize to zero. ISO 8601 text is the canonical client input; no rejecting JSON date-time format assertion is established here. Account/action hooks may add preconditions.",
                        "examples": [
                          "2026-10-15T10:00:00+02:00"
                        ],
                        "x-edoobox-requiredOnCreate": true,
                        "x-edoobox-sourceLine": 118
                      },
                      "booking_maximum": {
                        "x-edoobox-requiredOnCreate": true,
                        "x-edoobox-schemaStatus": "source-inferred",
                        "x-edoobox-sourceLine": 131,
                        "x-edoobox-canonicalType": "integer",
                        "x-edoobox-normalization": "PHP coercion/normalization is applied by the Structure getter; its return type is not a rejecting wire-input type restriction.",
                        "examples": [
                          1
                        ]
                      },
                      "total_award": {
                        "x-edoobox-requiredOnCreate": true,
                        "x-edoobox-schemaStatus": "source-inferred",
                        "x-edoobox-sourceLine": 147,
                        "x-edoobox-canonicalType": "number",
                        "x-edoobox-normalization": "PHP coercion/normalization is applied by the Structure getter; its return type is not a rejecting wire-input type restriction.",
                        "examples": [
                          1
                        ]
                      },
                      "minimum_amount": {
                        "x-edoobox-requiredOnCreate": true,
                        "x-edoobox-schemaStatus": "source-inferred",
                        "x-edoobox-sourceLine": 163,
                        "x-edoobox-canonicalType": "number",
                        "x-edoobox-normalization": "PHP coercion/normalization is applied by the Structure getter; its return type is not a rejecting wire-input type restriction.",
                        "examples": [
                          1
                        ]
                      },
                      "bookingType": {
                        "x-edoobox-knownInputs": [
                          "all",
                          "normal",
                          "offerlist",
                          "waitinglist"
                        ],
                        "x-edoobox-normalization": "Switch default normalizes other input values; case labels are not an exhaustive accepted-input enum.",
                        "examples": [
                          "all"
                        ],
                        "x-edoobox-sourceLine": 179
                      },
                      "allowedDomains": {
                        "description": "Retains strings passing email check or FILTER_VALIDATE_URL(http://+entry). Invalid entries filtered, not rejected; non-array becomes[]. Original keys retained, so sparse result can output object.\n\nNon-array ->[]. Email or prepended-http URL filter; array_filter preserves numeric/string keys, so response may be list or keyed object. Retained members are not cast: PHP filter/concatenation may coerce nonstring members during checks, but original values remain in encoded output.\n\nScope / limitations: URL-like validation is not strict DNS domain validation; no rejecting hostname/uniqueItems rule.",
                        "x-edoobox-canonicalType": "array",
                        "x-edoobox-canonicalItems": "string",
                        "x-edoobox-schemaStatus": "source-reviewed",
                        "examples": [
                          [
                            "member@example.invalid",
                            "example.invalid"
                          ]
                        ],
                        "x-edoobox-contractSource": [
                          {
                            "file": "application/models/v2/Promotion.php",
                            "line": 199,
                            "lineStart": 199,
                            "lineEnd": 224,
                            "sha256": "ae40bd3c823c841d443c8b4b2c089c1ecd8f75d97977e7ea7fc7fc5d26d8a837",
                            "spanSha256": "0cb8eb465f78c11358b80b495bbee4a96232b89c3911d60087e8055ca58d0bcd",
                            "reason": "Structure getter, output setter and field flags."
                          },
                          {
                            "file": "application/models/v2/Promotion.php",
                            "line": 408,
                            "lineStart": 408,
                            "lineEnd": 431,
                            "sha256": "ae40bd3c823c841d443c8b4b2c089c1ecd8f75d97977e7ea7fc7fc5d26d8a837",
                            "spanSha256": "83a60a84e14eee2a9bc3c9e7fed5dcf05c188b7b259acb6a554a1a309a228e7b",
                            "reason": "Actual resource dispatch and generic writer reachability; action branches are distinct."
                          },
                          {
                            "file": "docs/openapi/reviews/domain-fields.json",
                            "line": 1,
                            "reason": "Independent field-level source review, direction applicability, examples and explicit runtime limitations.",
                            "sha256": "6b38123b776600a328c8e844b0ecd6e0a579144081a345e335400dad52a9a5db"
                          }
                        ]
                      },
                      "tags": {
                        "type": "array",
                        "items": {
                          "type": "object",
                          "properties": {
                            "tag": {
                              "type": "string",
                              "pattern": "^tag_[a-f0-9]{12}_-?[0-9]+$",
                              "description": "Public tag v2 ID returned for a currently existing record in the selected account; signature, resource type and account ownership are checked by the native hook."
                            },
                            "type": {
                              "type": "string",
                              "enum": [
                                "include",
                                "exclude"
                              ]
                            }
                          },
                          "additionalProperties": true,
                          "required": [
                            "tag",
                            "type"
                          ]
                        },
                        "description": "Replaces include/exclude tag associations. Requires a JSON list; every typed public tag must exist in the selected account. Unknown modes and any invalid/foreign member reject before relation writes. Duplicate mode/tag pairs are normalized; [] clears.",
                        "x-edoobox-contractSource": [
                          {
                            "file": "application/models/v2/Promotionfunc.php",
                            "line": 190,
                            "lineEnd": 194,
                            "reason": "The tag callback validates the full replacement before reading/changing existing relations.",
                            "sha256": "e3297b0b3eb11dce16d9c360da859ed2f2f6a8b0fd6a6eedb1f352b94695a7f0"
                          },
                          {
                            "file": "application/models/v2/Promotionfunc.php",
                            "line": 268,
                            "lineEnd": 295,
                            "reason": "Strict list and include/exclude modes, typed tag IDs and complete same-account existence check; invalid input throws ED80100 promotion_tags_invalid.",
                            "sha256": "e3297b0b3eb11dce16d9c360da859ed2f2f6a8b0fd6a6eedb1f352b94695a7f0"
                          },
                          {
                            "file": "application/models/v2/Promotion.php",
                            "line": 241,
                            "reason": "Response builds an array of tag/type objects, not a scalar encoded ID.",
                            "sha256": "ae40bd3c823c841d443c8b4b2c089c1ecd8f75d97977e7ea7fc7fc5d26d8a837"
                          }
                        ]
                      },
                      "currency": {
                        "x-edoobox-canonicalType": "string",
                        "x-edoobox-maxStoredLength": 3,
                        "x-edoobox-normalization": "The aP getter trims text, replaces newlines and limits the legacy escaped storage representation to maxStoredLength UTF-8 characters without splitting escape pairs; aQ decodes the stored representation. Non-string input becomes empty text. This getter limit is normalization, not a rejecting input maxLength or proof of a custom action hook or database column capacity.",
                        "examples": [
                          "Example"
                        ],
                        "x-edoobox-writableOnUpdate": false,
                        "x-edoobox-requiredOnCreate": true,
                        "x-edoobox-sourceLine": 275
                      },
                      "code_alias": {
                        "x-edoobox-canonicalType": "string",
                        "description": "Trim/delete chars outside A-Z/a-z/0-9/_/-, then aP(...,true,10). Invalid characters/excess length normalize, not reject.\n\npreg_replace removes disallowed characters; aP truncates resulting escaped string to10.",
                        "x-edoobox-schemaStatus": "source-reviewed",
                        "examples": [
                          "SAVE_30"
                        ],
                        "x-edoobox-contractSource": [
                          {
                            "file": "application/models/v2/Promotion.php",
                            "line": 289,
                            "lineStart": 289,
                            "lineEnd": 302,
                            "sha256": "ae40bd3c823c841d443c8b4b2c089c1ecd8f75d97977e7ea7fc7fc5d26d8a837",
                            "spanSha256": "98c33f91ed6539e507c58ca2df466b5f67601955f7ff8bc1178d92c596fb1f72",
                            "reason": "Structure getter, output setter and field flags."
                          },
                          {
                            "file": "application/helpers/edooboxhelp_helper.php",
                            "line": 11560,
                            "lineStart": 11560,
                            "lineEnd": 11577,
                            "sha256": "090d351b5bde81813c7a829bedf2f1f9f978fce5765f246989779f996198934e",
                            "spanSha256": "47b45db25b5ed86673fe43c17c7d716427b0d86011b1ba918d19eebc39907fd1",
                            "reason": "Actual aP normalization, no rejecting maxLength. Reviewed aP update preserves legacy encoded storage and aQ read semantics. Truncation removes a dangling final escape backslash rather than creating a broken SQL literal; it remains normalization, not a rejecting raw input maxLength."
                          },
                          {
                            "file": "application/models/v2/Promotion.php",
                            "line": 408,
                            "lineStart": 408,
                            "lineEnd": 431,
                            "sha256": "ae40bd3c823c841d443c8b4b2c089c1ecd8f75d97977e7ea7fc7fc5d26d8a837",
                            "spanSha256": "83a60a84e14eee2a9bc3c9e7fed5dcf05c188b7b259acb6a554a1a309a228e7b",
                            "reason": "Actual resource dispatch and generic writer reachability; action branches are distinct."
                          },
                          {
                            "file": "docs/openapi/reviews/domain-fields.json",
                            "line": 1,
                            "reason": "Independent field-level source review, direction applicability, examples and explicit runtime limitations.",
                            "sha256": "6b38123b776600a328c8e844b0ecd6e0a579144081a345e335400dad52a9a5db"
                          }
                        ]
                      },
                      "settlement": {
                        "x-edoobox-knownInputs": [
                          "percent",
                          "amount"
                        ],
                        "x-edoobox-normalization": "Switch default normalizes other input values; case labels are not an exhaustive accepted-input enum.",
                        "examples": [
                          "percent"
                        ],
                        "x-edoobox-requiredOnCreate": true,
                        "x-edoobox-sourceLine": 303
                      },
                      "validity_range": {
                        "type": "array",
                        "items": {
                          "type": "string",
                          "pattern": "^(?:offer|category)_[a-f0-9]{12}_-?[0-9]+$",
                          "description": "Public offer or category v2 ID returned for an existing same-account course or folder/root2 respectively."
                        },
                        "description": "JSON list of account-owned existing offers/categories. Complete typed/resource-subtype validation happens before validity relations change; duplicate targets are normalized and [] clears the range.",
                        "x-edoobox-contractSource": [
                          {
                            "file": "application/models/v2/Promotionfunc.php",
                            "line": 58,
                            "lineEnd": 62,
                            "reason": "PUT validates the full range before changing existing validity relations.",
                            "sha256": "e3297b0b3eb11dce16d9c360da859ed2f2f6a8b0fd6a6eedb1f352b94695a7f0"
                          },
                          {
                            "file": "application/models/v2/Promotionfunc.php",
                            "line": 124,
                            "lineEnd": 126,
                            "reason": "POST relation callback uses the same validator.",
                            "sha256": "e3297b0b3eb11dce16d9c360da859ed2f2f6a8b0fd6a6eedb1f352b94695a7f0"
                          },
                          {
                            "file": "application/models/v2/Promotionfunc.php",
                            "line": 150,
                            "lineEnd": 180,
                            "reason": "Only typed offer/category IDs, list shape and positive decoded references; same-account DB checks distinguish kurs from ordner/root2.",
                            "sha256": "e3297b0b3eb11dce16d9c360da859ed2f2f6a8b0fd6a6eedb1f352b94695a7f0"
                          },
                          {
                            "file": "application/models/v2/Promotion.php",
                            "line": 343,
                            "reason": "Response returns an array of public offer/category IDs.",
                            "sha256": "ae40bd3c823c841d443c8b4b2c089c1ecd8f75d97977e7ea7fc7fc5d26d8a837"
                          }
                        ]
                      }
                    },
                    "additionalProperties": true,
                    "description": "Source-declared fields; action-specific and account validation still apply.",
                    "required": [
                      "name",
                      "creation",
                      "offsetting",
                      "date_start",
                      "date_end",
                      "booking_maximum",
                      "total_award",
                      "minimum_amount",
                      "currency",
                      "code_alias",
                      "settlement"
                    ]
                  }
                }
              ],
              "x-edoobox-readOnlyFields": [],
              "x-edoobox-clientRestriction": "The server-generated id is forbidden. insert:false fields are readOnly and tolerated for existing Vue payloads because the API skips them."
            },
            "id": {
              "type": "string",
              "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$",
              "description": "Opaque edoobox v2 object ID returned by this account. Never send a raw database ID. The synthetic example is illustrative and is not a real record.",
              "examples": [
                "promotion_012345abcdef_123456"
              ]
            }
          },
          "additionalProperties": true,
          "required": [
            "data"
          ]
        },
        "examples": {
          "request": {
            "summary": "Rabatt- oder Gutscheinkampagne anlegen",
            "value": {
              "data": {
                "name": "Herbstaktion",
                "status": true,
                "creation": "campaign",
                "offsetting": "total",
                "date_start": "2026-11-01T00:00:00+01:00",
                "date_end": "2026-11-30T23:59:59+01:00",
                "booking_maximum": 1,
                "total_award": 10,
                "minimum_amount": 50,
                "currency": "CHF",
                "code_alias": "HERBST",
                "settlement": "percent",
                "validity_range": [
                  "offer_012345abcdef_123456"
                ],
                "tags": []
              }
            }
          }
        }
      }
    }
  },
  "x-edoobox-runtimeMutationGuard": true,
  "x-edoobox-documentationReview": {
    "file": "docs/openapi/operation-contracts/08-subscriptions.json",
    "notes": []
  },
  "x-edoobox-source": {
    "file": "application/models/v2/Promotion.php",
    "method": "postPromotion",
    "line": 408
  },
  "x-edoobox-documentationStatus": "reviewed",
  "x-edoobox-readOnly": false,
  "x-edoobox-safeForAutomation": false,
  "x-edoobox-permission": {
    "resource": "promotion",
    "short": "prom",
    "checkedByDispatcher": true,
    "levels": [
      2,
      3,
      4
    ],
    "description": "Resource permission mapping from APIPermissions(), Authfunc::_getCheckJWT. Additional model/admin/plugin checks may apply; resources absent from api_permission do not acquire a fictitious scope."
  }
}

Aufruf vorbereiten

Beispiel

Platzhalter ersetzen und Vertragsangaben prüfen. Die Beispiele werden hier nicht ausgeführt.

cURL

# Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich.
# Request Body: synthetisches Beispiel aus der Spezifikation; Werte und Vollständigkeit vor Verwendung prüfen.
: "${API_ORIGIN:?API_ORIGIN setzen}"
: "${AUTH_BEARERAUTH:?AUTH_BEARERAUTH setzen}"
: "${AUTH_ACCOUNTCONTEXT:?AUTH_ACCOUNTCONTEXT setzen}"
cat > payload.json <<'EDOOBOX_JSON_EXAMPLE'
{
  "data": {
    "name": "Herbstaktion",
    "status": true,
    "creation": "campaign",
    "offsetting": "total",
    "date_start": "2026-11-01T00:00:00+01:00",
    "date_end": "2026-11-30T23:59:59+01:00",
    "booking_maximum": 1,
    "total_award": 10,
    "minimum_amount": 50,
    "currency": "CHF",
    "code_alias": "HERBST",
    "settlement": "percent",
    "validity_range": [
      "offer_012345abcdef_123456"
    ],
    "tags": []
  }
}
EDOOBOX_JSON_EXAMPLE
curl --request 'POST' \
  --url "${API_ORIGIN%/}"'/v2/promotion' \
  --header 'Authorization: Bearer '"${AUTH_BEARERAUTH}" \
  --header 'edid: '"${AUTH_ACCOUNTCONTEXT}" \
  --header 'Content-Type: application/json' \
  --data-binary '@payload.json'

JavaScript

// Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich.
// Request Body: synthetisches Beispiel aus der Spezifikation; Werte und Vollständigkeit vor Verwendung prüfen.
const required = (name) => {
  const value = process.env[name];
  if (!value) throw new Error(`Set ${name}`);
  return value;
};
let path = "/v2/promotion";
const origin = required('API_ORIGIN');
const url = new URL((origin.endsWith('/') ? origin.slice(0, -1) : origin) + path);
const headers = {};
headers["Authorization"] = "Bearer " + required("AUTH_BEARERAUTH");
headers["edid"] = "" + required("AUTH_ACCOUNTCONTEXT");
headers['Content-Type'] = "application/json";
const body = JSON.stringify({
  "data": {
    "name": "Herbstaktion",
    "status": true,
    "creation": "campaign",
    "offsetting": "total",
    "date_start": "2026-11-01T00:00:00+01:00",
    "date_end": "2026-11-30T23:59:59+01:00",
    "booking_maximum": 1,
    "total_award": 10,
    "minimum_amount": 50,
    "currency": "CHF",
    "code_alias": "HERBST",
    "settlement": "percent",
    "validity_range": [
      "offer_012345abcdef_123456"
    ],
    "tags": []
  }
});
const response = await fetch(url, { method: "POST", headers, body, redirect: 'manual' });
const text = await response.text();
console.log(response.status, text);
// HTTP-Status und dokumentierte error/success-Felder gemeinsam prüfen.

Python

# Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich.
# Request Body: synthetisches Beispiel aus der Spezifikation; Werte und Vollständigkeit vor Verwendung prüfen.
import os
import urllib.parse
import urllib.request
import urllib.error

path = "/v2/promotion"
url = os.environ["API_ORIGIN"].rstrip("/") + path
headers = {}
headers["Authorization"] = "Bearer " + os.environ["AUTH_BEARERAUTH"]
headers["edid"] = "" + os.environ["AUTH_ACCOUNTCONTEXT"]
headers["Content-Type"] = "application/json"
body = "{\"data\":{\"name\":\"Herbstaktion\",\"status\":true,\"creation\":\"campaign\",\"offsetting\":\"total\",\"date_start\":\"2026-11-01T00:00:00+01:00\",\"date_end\":\"2026-11-30T23:59:59+01:00\",\"booking_maximum\":1,\"total_award\":10,\"minimum_amount\":50,\"currency\":\"CHF\",\"code_alias\":\"HERBST\",\"settlement\":\"percent\",\"validity_range\":[\"offer_012345abcdef_123456\"],\"tags\":[]}}".encode("utf-8")

# Redirects nicht automatisch verfolgen.
class NoRedirect(urllib.request.HTTPRedirectHandler):
    def redirect_request(self, req, fp, code, msg, headers, newurl):
        return None
request = urllib.request.Request(url, headers=headers, method="POST", data=body)
try:
    response = urllib.request.build_opener(NoRedirect).open(request, timeout=30)
except urllib.error.HTTPError as error:
    response = error
print(response.status, response.read().decode("utf-8", errors="replace"))
# HTTP-Status und dokumentierte error/success-Felder gemeinsam prüfen.

Ohne JavaScript können Sie die weiteren Aufrufbeispiele hier aufklappen und den Code manuell kopieren.

JavaScript

// Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich.
// Request Body: synthetisches Beispiel aus der Spezifikation; Werte und Vollständigkeit vor Verwendung prüfen.
const required = (name) => {
  const value = process.env[name];
  if (!value) throw new Error(`Set ${name}`);
  return value;
};
let path = "/v2/promotion";
const origin = required('API_ORIGIN');
const url = new URL((origin.endsWith('/') ? origin.slice(0, -1) : origin) + path);
const headers = {};
headers["Authorization"] = "Bearer " + required("AUTH_BEARERAUTH");
headers["edid"] = "" + required("AUTH_ACCOUNTCONTEXT");
headers['Content-Type'] = "application/json";
const body = JSON.stringify({
  "data": {
    "name": "Herbstaktion",
    "status": true,
    "creation": "campaign",
    "offsetting": "total",
    "date_start": "2026-11-01T00:00:00+01:00",
    "date_end": "2026-11-30T23:59:59+01:00",
    "booking_maximum": 1,
    "total_award": 10,
    "minimum_amount": 50,
    "currency": "CHF",
    "code_alias": "HERBST",
    "settlement": "percent",
    "validity_range": [
      "offer_012345abcdef_123456"
    ],
    "tags": []
  }
});
const response = await fetch(url, { method: "POST", headers, body, redirect: 'manual' });
const text = await response.text();
console.log(response.status, text);
// HTTP-Status und dokumentierte error/success-Felder gemeinsam prüfen.

Python

# Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich.
# Request Body: synthetisches Beispiel aus der Spezifikation; Werte und Vollständigkeit vor Verwendung prüfen.
import os
import urllib.parse
import urllib.request
import urllib.error

path = "/v2/promotion"
url = os.environ["API_ORIGIN"].rstrip("/") + path
headers = {}
headers["Authorization"] = "Bearer " + os.environ["AUTH_BEARERAUTH"]
headers["edid"] = "" + os.environ["AUTH_ACCOUNTCONTEXT"]
headers["Content-Type"] = "application/json"
body = "{\"data\":{\"name\":\"Herbstaktion\",\"status\":true,\"creation\":\"campaign\",\"offsetting\":\"total\",\"date_start\":\"2026-11-01T00:00:00+01:00\",\"date_end\":\"2026-11-30T23:59:59+01:00\",\"booking_maximum\":1,\"total_award\":10,\"minimum_amount\":50,\"currency\":\"CHF\",\"code_alias\":\"HERBST\",\"settlement\":\"percent\",\"validity_range\":[\"offer_012345abcdef_123456\"],\"tags\":[]}}".encode("utf-8")

# Redirects nicht automatisch verfolgen.
class NoRedirect(urllib.request.HTTPRedirectHandler):
    def redirect_request(self, req, fp, code, msg, headers, newurl):
        return None
request = urllib.request.Request(url, headers=headers, method="POST", data=body)
try:
    response = urllib.request.build_opener(NoRedirect).open(request, timeout=30)
except urllib.error.HTTPError as error:
    response = error
print(response.status, response.read().decode("utf-8", errors="replace"))
# HTTP-Status und dokumentierte error/success-Felder gemeinsam prüfen.

Server aus der Spezifikation

https://app2.edoobox.com

edoobox API

Verwenden Sie die für Ihre Integration bestätigte API-Basis-URL. Ein lokaler Entwicklungsserver ist keine Produktionsadresse.

Als Markdown lesenEin Endpunkt. Vollständig. Für Menschen und LLM.