# PUT /v2/promotion Kampagne und Gültigkeitszuordnungen ändern Ändert eine Kampagne. currency bleibt unveränderlich. Übergebene validity_range- und tags-Listen ersetzen jeweils alle Zuordnungen; [] entfernt sie. Die Hooks prüfen alle IDs und Kontozuordnungen vor der Änderung. - Operation-ID: put_v2_promotion - Dokumentation: /docs/api/v2/operations/put-v2-promotion-27edf63f6f17/ - OpenAPI-Version: 3.2.1 - Vollständige Spezifikation: /docs/api/v2/openapi.json - Dokumentationsstatus: reviewed - Ändert Zustand: ja - Für Automation freigegeben: nein ## Server Serverwerte stammen unverändert aus der Datei. Eine lokale Entwicklungsadresse ist keine bestätigte Produktionsadresse. `API_ORIGIN` muss auf die passende Instanz gesetzt werden. ```json [ { "url": "https://app2.edoobox.com", "description": "edoobox API" } ] ``` ## Authentifizierung Eine der folgenden Alternativen genügt (ODER). Innerhalb einer Alternative müssen alle Verfahren gemeinsam erfüllt sein (UND). 1. **bearerAuth** (HTTP bearer) — Existing edoobox v2 access token. Never substitute API key/secret headers. **UND** **accountContext** (header: edid) — Selected login/account context from the JWT, not a database primary key. Required even for a JWT with one account. 2. **sessionCookie** (cookie: _edlogin) — Existing browser login session, with the same permission checks as Bearer authentication. **UND** **accountContext** (header: edid) — Selected login/account context from the JWT, not a database primary key. Required even for a JWT with one account. ### Wirksame Security Requirements und vollständige Verfahren ```json { "security": [ { "bearerAuth": [], "accountContext": [] }, { "sessionCookie": [], "accountContext": [] } ], "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT", "description": "Existing edoobox v2 access token. Never substitute API key/secret headers." }, "accountContext": { "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." }, "sessionCookie": { "type": "apiKey", "in": "cookie", "name": "_edlogin", "description": "Existing browser login session, with the same permission checks as Bearer authentication." } } } ``` ## Parameter | Name | Ort | Pflicht | Beschreibung | | --- | --- | --- | --- | | language | header | nein | Account language code, where the resource supports setLanguage(). | | X-Edoobox-If-Revision | header | nein | 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. | ### Vollständige wirksame Parameterdefinitionen ```json [ { "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." } ] ``` ## Anfrage ```json { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "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": "0da1cbbf108a5871b54204c3c76aaf59dabf85a6886bfb38210136885cfc1667" } ] }, "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": "0da1cbbf108a5871b54204c3c76aaf59dabf85a6886bfb38210136885cfc1667" } ] }, "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": false, "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": "0da1cbbf108a5871b54204c3c76aaf59dabf85a6886bfb38210136885cfc1667" } ] }, "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.", "minProperties": 1, "x-edoobox-readOnlyFields": [ "currency" ], "x-edoobox-clientRestriction": "Read-only fields are forbidden by this client contract to prevent silently ignored writes; the legacy API itself skips them. Explicit source-marked update context fields remain accepted for hook validation without changing their immutable database columns." }, "id": { "type": "string", "pattern": "^promotion_[a-f0-9]{12}_-?[0-9]+$", "examples": [ "promotion_012345abcdef_123456" ], "description": "Öffentliche v2-ID aus dem ausgewählten Konto; Beispiel ist synthetisch." } }, "additionalProperties": true, "required": [ "data", "id" ] }, "examples": { "request": { "summary": "Kampagne und Gültigkeitszuordnungen ändern", "value": { "data": { "status": false }, "id": "promotion_012345abcdef_123456" } } } } } } ``` ## Antworten HTTP-Status und Antwortinhalt gemeinsam auswerten. Die folgenden Beschreibungen und Schemata sind die Angaben der Quelldatei. ```json { "200": { "description": "Generische Update-Bestätigung mit update und öffentlicher ID.", "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" } } } } } ``` ## Aufrufbeispiele Anpassen vor dem Ausführen. Platzhalter und veröffentlichte Beispiele sind synthetisch. Die Beispiele senden hier keine Anfrage; sie ergänzen keine unbekannten Pflichtfelder. ### cURL ```sh # 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": { "status": false }, "id": "promotion_012345abcdef_123456" } EDOOBOX_JSON_EXAMPLE curl --request 'PUT' \ --url "${API_ORIGIN%/}"'/v2/promotion' \ --header 'Authorization: Bearer '"${AUTH_BEARERAUTH}" \ --header 'edid: '"${AUTH_ACCOUNTCONTEXT}" \ --header 'Content-Type: application/json' \ --data-binary '@payload.json' ``` ### JavaScript (Node.js) ```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": { "status": false }, "id": "promotion_012345abcdef_123456" }); const response = await fetch(url, { method: "PUT", 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 ```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\":{\"status\":false},\"id\":\"promotion_012345abcdef_123456\"}".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="PUT", 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. ``` ## Vollständige Operationsdefinition und edoobox-Hinweise Alle Originalfelder einschliesslich `x-edoobox-*`, requestBody und responses bleiben erhalten. Teilweise dokumentierte Schemata sind kein vollständiger Validierungsvertrag. ```json { "operationId": "put_v2_promotion", "summary": "Kampagne und Gültigkeitszuordnungen ändern", "description": "Ändert eine Kampagne. currency bleibt unveränderlich. Übergebene validity_range- und tags-Listen ersetzen jeweils alle Zuordnungen; [] entfernt sie. Die Hooks prüfen alle IDs und Kontozuordnungen vor der Änderung.", "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 Update-Bestätigung mit update und öffentlicher ID.", "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": { "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": "0da1cbbf108a5871b54204c3c76aaf59dabf85a6886bfb38210136885cfc1667" } ] }, "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": "0da1cbbf108a5871b54204c3c76aaf59dabf85a6886bfb38210136885cfc1667" } ] }, "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": false, "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": "0da1cbbf108a5871b54204c3c76aaf59dabf85a6886bfb38210136885cfc1667" } ] }, "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.", "minProperties": 1, "x-edoobox-readOnlyFields": [ "currency" ], "x-edoobox-clientRestriction": "Read-only fields are forbidden by this client contract to prevent silently ignored writes; the legacy API itself skips them. Explicit source-marked update context fields remain accepted for hook validation without changing their immutable database columns." }, "id": { "type": "string", "pattern": "^promotion_[a-f0-9]{12}_-?[0-9]+$", "examples": [ "promotion_012345abcdef_123456" ], "description": "Öffentliche v2-ID aus dem ausgewählten Konto; Beispiel ist synthetisch." } }, "additionalProperties": true, "required": [ "data", "id" ] }, "examples": { "request": { "summary": "Kampagne und Gültigkeitszuordnungen ändern", "value": { "data": { "status": false }, "id": "promotion_012345abcdef_123456" } } } } } }, "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": "updatePromotion", "line": 424 }, "x-edoobox-documentationStatus": "reviewed", "x-edoobox-readOnly": false, "x-edoobox-safeForAutomation": false, "x-edoobox-permission": { "resource": "promotion", "short": "prom", "checkedByDispatcher": true, "levels": [ 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." } } ```