# POST /v2/automationrule/{id}/activate Automationsregel aktivieren Validiert die gespeicherte Regel einschließlich aktueller Kontofelder, Tags und Vorlagen und setzt sie bei Erfolg auf active. Die Requestdaten werden ignoriert. Schlägt die Validierung fehl, werden Fehler dauerhaft gespeichert und eine zuvor aktive Regel wird auf paused gesetzt; auch die Fehlerantwort kann deshalb Zustand verändern. Aktivieren führt selbst keine Regelaktion aus. Regel-/Ausführungszeitstempel werden als ISO-8601-String oder null ausgegeben. - Operation-ID: post_v2_automationrule_id_activate - Dokumentation: /docs/api/v2/operations/post-v2-automationrule-id-activate-6265e7c84c73/ - 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 | | --- | --- | --- | --- | | id | path | ja | v2 object identifier in the selected account. | | 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": "id", "in": "path", "required": true, "description": "v2 object identifier in the selected account.", "schema": { "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": [ "automationrule_012345abcdef_123456" ] } }, { "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": false, "content": { "application/json": { "schema": { "type": "object", "properties": {}, "additionalProperties": true }, "examples": { "request": { "summary": "Automationsregel aktivieren", "value": {} } } } } } ``` ## Antworten HTTP-Status und Antwortinhalt gemeinsam auswerten. Die folgenden Beschreibungen und Schemata sind die Angaben der Quelldatei. ```json { "200": { "description": "data enthält das dokumentierte Ergebnisobjekt bzw. die Ergebnisliste; error=false und success=true.", "content": { "application/json": { "example": { "success": true, "error": false, "data": { "update": true, "active": true, "id": "automationrule_012345abcdef_123456", "name": "Neue Kunden begrüßen", "description": "Notiz nach API-Erstellung", "status": "active", "stored_status": "active", "trigger": "api.post.user", "priority": 100, "condition_group": { "combinator": "and", "conditions": [] }, "actions": [ { "type": "note.create", "subject": "Neuer Kunde aus API", "message": "Datensatz prüfen", "targets": [ "user" ] } ], "summary": { "conditions": 0, "actions": 1 }, "definition_version": 1, "valid": true, "validation_errors": [], "activated_at": "2026-10-22T10:00:00+02:00", "created_at": "2026-10-22T10:00:00+02:00", "updated_at": "2026-10-22T10:00:00+02:00" } }, "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": [ "boolean", "string" ] }, "error_code": { "type": "string" }, "data": { "type": "object", "properties": { "update": { "const": true }, "active": { "const": true }, "id": { "type": "string", "pattern": "^automationrule_[a-f0-9]{12}_-?[0-9]+$", "description": "Öffentliche v2-ID aus dem aktuellen Konto." }, "name": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "status": { "type": "string", "enum": [ "draft", "active", "paused", "invalid" ] }, "stored_status": { "type": "string", "enum": [ "draft", "active", "paused" ] }, "trigger": { "type": "string" }, "priority": { "type": "integer" }, "condition_group": { "anyOf": [ { "type": [ "object", "array", "string", "number", "boolean" ], "properties": { "combinator": { "type": "string", "description": "and/or (kleingeschrieben normalisiert), Standard and." }, "operator": { "type": "string", "description": "Eingabealias für combinator." }, "conditions": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "field": { "type": "string", "description": "Kontextfeld aus dem Katalog, z.B. user.email. Kontofelder user.data_fields.data_1 … data_30 nur gemäß account_options." }, "data_type": { "type": "string", "description": "Optional für feste Felder; bei dynamischen Kontofeldern erforderlich und mit dem Kontokatalog abzugleichen (z.B. text/date)." }, "value_type": { "type": "string", "description": "Eingabealias für data_type." }, "operator": { "type": "string", "description": "Operator aus dem Katalog. is_empty/is_not_empty/is_true/is_false benötigen keinen value." }, "value": { "description": "Typ abhängig von Feld/Operator: Textstring (max. 2000 Zeichen), Zahl oder Zahlenpaar, ISO-Datum YYYY-MM-DD bzw. Datumspaar, Alter 0–150 oder Liste öffentlicher Tag-IDs. identifier-Vergleiche verlangen passende v2-ID. Kein Feldwert wird allein durch Simulation verändert." } }, "additionalProperties": true, "required": [ "field", "operator" ] }, { "type": "object", "properties": { "combinator": { "type": "string", "description": "and/or (kleingeschrieben normalisiert), Standard and." }, "operator": { "type": "string", "description": "Eingabealias für combinator." }, "conditions": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Kontextfeld aus dem Katalog, z.B. user.email. Kontofelder user.data_fields.data_1 … data_30 nur gemäß account_options." }, "data_type": { "type": "string", "description": "Optional für feste Felder; bei dynamischen Kontofeldern erforderlich und mit dem Kontokatalog abzugleichen (z.B. text/date)." }, "value_type": { "type": "string", "description": "Eingabealias für data_type." }, "operator": { "type": "string", "description": "Operator aus dem Katalog. is_empty/is_not_empty/is_true/is_false benötigen keinen value." }, "value": { "description": "Typ abhängig von Feld/Operator: Textstring (max. 2000 Zeichen), Zahl oder Zahlenpaar, ISO-Datum YYYY-MM-DD bzw. Datumspaar, Alter 0–150 oder Liste öffentlicher Tag-IDs. identifier-Vergleiche verlangen passende v2-ID. Kein Feldwert wird allein durch Simulation verändert." } }, "additionalProperties": true, "required": [ "field", "operator" ] } }, "items": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Kontextfeld aus dem Katalog, z.B. user.email. Kontofelder user.data_fields.data_1 … data_30 nur gemäß account_options." }, "data_type": { "type": "string", "description": "Optional für feste Felder; bei dynamischen Kontofeldern erforderlich und mit dem Kontokatalog abzugleichen (z.B. text/date)." }, "value_type": { "type": "string", "description": "Eingabealias für data_type." }, "operator": { "type": "string", "description": "Operator aus dem Katalog. is_empty/is_not_empty/is_true/is_false benötigen keinen value." }, "value": { "description": "Typ abhängig von Feld/Operator: Textstring (max. 2000 Zeichen), Zahl oder Zahlenpaar, ISO-Datum YYYY-MM-DD bzw. Datumspaar, Alter 0–150 oder Liste öffentlicher Tag-IDs. identifier-Vergleiche verlangen passende v2-ID. Kein Feldwert wird allein durch Simulation verändert." } }, "additionalProperties": true, "required": [ "field", "operator" ] } } }, "additionalProperties": true, "description": "Bedingungsgruppe; höchstens zwei Gruppenebenen und insgesamt 50 Blattbedingungen. Leere Gruppe trifft zu. conditions/items und combinator/operator sind Eingabealiase." } ] } }, "items": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "field": { "type": "string", "description": "Kontextfeld aus dem Katalog, z.B. user.email. Kontofelder user.data_fields.data_1 … data_30 nur gemäß account_options." }, "data_type": { "type": "string", "description": "Optional für feste Felder; bei dynamischen Kontofeldern erforderlich und mit dem Kontokatalog abzugleichen (z.B. text/date)." }, "value_type": { "type": "string", "description": "Eingabealias für data_type." }, "operator": { "type": "string", "description": "Operator aus dem Katalog. is_empty/is_not_empty/is_true/is_false benötigen keinen value." }, "value": { "description": "Typ abhängig von Feld/Operator: Textstring (max. 2000 Zeichen), Zahl oder Zahlenpaar, ISO-Datum YYYY-MM-DD bzw. Datumspaar, Alter 0–150 oder Liste öffentlicher Tag-IDs. identifier-Vergleiche verlangen passende v2-ID. Kein Feldwert wird allein durch Simulation verändert." } }, "additionalProperties": true, "required": [ "field", "operator" ] }, { "type": "object", "properties": { "combinator": { "type": "string", "description": "and/or (kleingeschrieben normalisiert), Standard and." }, "operator": { "type": "string", "description": "Eingabealias für combinator." }, "conditions": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Kontextfeld aus dem Katalog, z.B. user.email. Kontofelder user.data_fields.data_1 … data_30 nur gemäß account_options." }, "data_type": { "type": "string", "description": "Optional für feste Felder; bei dynamischen Kontofeldern erforderlich und mit dem Kontokatalog abzugleichen (z.B. text/date)." }, "value_type": { "type": "string", "description": "Eingabealias für data_type." }, "operator": { "type": "string", "description": "Operator aus dem Katalog. is_empty/is_not_empty/is_true/is_false benötigen keinen value." }, "value": { "description": "Typ abhängig von Feld/Operator: Textstring (max. 2000 Zeichen), Zahl oder Zahlenpaar, ISO-Datum YYYY-MM-DD bzw. Datumspaar, Alter 0–150 oder Liste öffentlicher Tag-IDs. identifier-Vergleiche verlangen passende v2-ID. Kein Feldwert wird allein durch Simulation verändert." } }, "additionalProperties": true, "required": [ "field", "operator" ] } }, "items": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Kontextfeld aus dem Katalog, z.B. user.email. Kontofelder user.data_fields.data_1 … data_30 nur gemäß account_options." }, "data_type": { "type": "string", "description": "Optional für feste Felder; bei dynamischen Kontofeldern erforderlich und mit dem Kontokatalog abzugleichen (z.B. text/date)." }, "value_type": { "type": "string", "description": "Eingabealias für data_type." }, "operator": { "type": "string", "description": "Operator aus dem Katalog. is_empty/is_not_empty/is_true/is_false benötigen keinen value." }, "value": { "description": "Typ abhängig von Feld/Operator: Textstring (max. 2000 Zeichen), Zahl oder Zahlenpaar, ISO-Datum YYYY-MM-DD bzw. Datumspaar, Alter 0–150 oder Liste öffentlicher Tag-IDs. identifier-Vergleiche verlangen passende v2-ID. Kein Feldwert wird allein durch Simulation verändert." } }, "additionalProperties": true, "required": [ "field", "operator" ] } } }, "additionalProperties": true, "description": "Bedingungsgruppe; höchstens zwei Gruppenebenen und insgesamt 50 Blattbedingungen. Leere Gruppe trifft zu. conditions/items und combinator/operator sind Eingabealiase." } ] } } }, "additionalProperties": true, "description": "Bedingungsgruppe; höchstens zwei Gruppenebenen und insgesamt 50 Blattbedingungen. Leere Gruppe trifft zu. conditions/items und combinator/operator sind Eingabealiase." }, { "type": [ "object", "array", "string", "number", "boolean" ] } ], "description": "Normalisierte Definition. Gespeicherte draft/paused-Regeln können trotz erfolgreicher Antwort ungültige Inhalte enthalten; valid und validation_errors beachten." }, "actions": { "type": "array", "items": { "description": "Normalisierte Aktion oder fehlerhafter Entwurfseintrag; Aktivierung erfordert vollständige Validierung.", "anyOf": [ { "type": "object", "additionalProperties": true, "properties": { "type": { "type": "string", "description": "user.update; user.tags.add/remove; email.send_template; note.create; communication.email_template.replace; communication.pdf_template.replace. Verfügbarkeit hängt vom Triggerkontext ab. Eingabealiase email.send sowie communication.*_template.override werden normalisiert." }, "fields": { "type": "object", "minProperties": 1, "additionalProperties": { "type": [ "string", "number", "boolean", "null" ] }, "description": "Offene, kontobezogene Feldwert-Map: user.first_name/last_name/gender/street/postcode/location/country/language/phone_number/email/company oder user.data_fields.data_N. Schreibbare Schlüssel und Typen aus GET /automationrule/catalog übernehmen; Werte müssen scalar oder null sein." }, "tags": { "type": "array", "minItems": 1, "maxItems": 50, "items": { "type": "string", "pattern": "^tag_[a-f0-9]{12}_-?[0-9]+$", "description": "Öffentliche v2-ID aus dem aktuellen Konto." } }, "template": { "type": "string", "pattern": "^et_[a-f0-9]{12}_-?[0-9]+$", "description": "Öffentliche v2-ID aus dem aktuellen Konto." }, "recipient": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "user_field", "offer_leaders" ] }, "field": { "type": "string", "description": "Bei user_field erforderlich: user.email oder textbasiertes user.data_fields.data_N aus account_options.user_email_fields." } }, "additionalProperties": true, "required": [ "type" ] }, "subject": { "type": "string", "maxLength": 255, "description": "Für note.create erforderlich und nach Trim nicht leer." }, "message": { "type": "string", "maxLength": 1000, "default": "" }, "targets": { "type": "array", "items": { "type": "string", "enum": [ "user", "booking" ] }, "minItems": 1, "maxItems": 2, "uniqueItems": true, "description": "Für note.create erforderlich; nur im Trigger vorhandene Kontexte." }, "configuration": { "type": "object", "additionalProperties": true, "description": "Eingabealias: Konfigurationsfelder werden neben type ausgepackt." } } }, { "type": [ "object", "array", "string", "number", "boolean", "null" ] } ] } }, "summary": { "type": "object", "properties": { "conditions": { "type": "integer" }, "actions": { "type": "integer" } }, "additionalProperties": true, "required": [ "conditions", "actions" ] }, "definition_version": { "type": "integer" }, "valid": { "type": "boolean" }, "validation_errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "code": { "type": "string" } }, "additionalProperties": true, "required": [ "path", "code" ] } }, "activated_at": { "type": [ "string", "null" ] }, "created_at": { "type": [ "string", "null" ] }, "updated_at": { "type": [ "string", "null" ] } }, "additionalProperties": true, "required": [ "update", "active", "id", "name", "description", "status", "stored_status", "trigger", "priority", "condition_group", "actions", "summary", "definition_version", "valid", "validation_errors", "activated_at", "created_at", "updated_at" ] }, "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. # cURL: PATH_* bereits URL-kodiert setzen. JavaScript/Python kodieren die unveränderten Pfadwerte selbst. : "${API_ORIGIN:?API_ORIGIN setzen}" : "${AUTH_BEARERAUTH:?AUTH_BEARERAUTH setzen}" : "${AUTH_ACCOUNTCONTEXT:?AUTH_ACCOUNTCONTEXT setzen}" : "${PATH_ID:?PATH_ID setzen}" cat > payload.json <<'EDOOBOX_JSON_EXAMPLE' {} EDOOBOX_JSON_EXAMPLE curl --request 'POST' \ --url "${API_ORIGIN%/}"'/v2/automationrule/'"${PATH_ID}"'/activate' \ --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/automationrule/{id}/activate"; path = path.replaceAll("{id}", encodeURIComponent(required("PATH_ID"))); 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({}); 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 ```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/automationrule/{id}/activate" path = path.replace("{id}", urllib.parse.quote(os.environ["PATH_ID"], safe="")) 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 = "{}".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. ``` ## 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": "post_v2_automationrule_id_activate", "summary": "Automationsregel aktivieren", "description": "Validiert die gespeicherte Regel einschließlich aktueller Kontofelder, Tags und Vorlagen und setzt sie bei Erfolg auf active. Die Requestdaten werden ignoriert. Schlägt die Validierung fehl, werden Fehler dauerhaft gespeichert und eine zuvor aktive Regel wird auf paused gesetzt; auch die Fehlerantwort kann deshalb Zustand verändern. Aktivieren führt selbst keine Regelaktion aus. Regel-/Ausführungszeitstempel werden als ISO-8601-String oder null ausgegeben.", "tags": [ "automationrule" ], "security": [ { "bearerAuth": [], "accountContext": [] }, { "sessionCookie": [], "accountContext": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "v2 object identifier in the selected account.", "schema": { "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": [ "automationrule_012345abcdef_123456" ] } }, { "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": "data enthält das dokumentierte Ergebnisobjekt bzw. die Ergebnisliste; error=false und success=true.", "content": { "application/json": { "example": { "success": true, "error": false, "data": { "update": true, "active": true, "id": "automationrule_012345abcdef_123456", "name": "Neue Kunden begrüßen", "description": "Notiz nach API-Erstellung", "status": "active", "stored_status": "active", "trigger": "api.post.user", "priority": 100, "condition_group": { "combinator": "and", "conditions": [] }, "actions": [ { "type": "note.create", "subject": "Neuer Kunde aus API", "message": "Datensatz prüfen", "targets": [ "user" ] } ], "summary": { "conditions": 0, "actions": 1 }, "definition_version": 1, "valid": true, "validation_errors": [], "activated_at": "2026-10-22T10:00:00+02:00", "created_at": "2026-10-22T10:00:00+02:00", "updated_at": "2026-10-22T10:00:00+02:00" } }, "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": [ "boolean", "string" ] }, "error_code": { "type": "string" }, "data": { "type": "object", "properties": { "update": { "const": true }, "active": { "const": true }, "id": { "type": "string", "pattern": "^automationrule_[a-f0-9]{12}_-?[0-9]+$", "description": "Öffentliche v2-ID aus dem aktuellen Konto." }, "name": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "status": { "type": "string", "enum": [ "draft", "active", "paused", "invalid" ] }, "stored_status": { "type": "string", "enum": [ "draft", "active", "paused" ] }, "trigger": { "type": "string" }, "priority": { "type": "integer" }, "condition_group": { "anyOf": [ { "type": [ "object", "array", "string", "number", "boolean" ], "properties": { "combinator": { "type": "string", "description": "and/or (kleingeschrieben normalisiert), Standard and." }, "operator": { "type": "string", "description": "Eingabealias für combinator." }, "conditions": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "field": { "type": "string", "description": "Kontextfeld aus dem Katalog, z.B. user.email. Kontofelder user.data_fields.data_1 … data_30 nur gemäß account_options." }, "data_type": { "type": "string", "description": "Optional für feste Felder; bei dynamischen Kontofeldern erforderlich und mit dem Kontokatalog abzugleichen (z.B. text/date)." }, "value_type": { "type": "string", "description": "Eingabealias für data_type." }, "operator": { "type": "string", "description": "Operator aus dem Katalog. is_empty/is_not_empty/is_true/is_false benötigen keinen value." }, "value": { "description": "Typ abhängig von Feld/Operator: Textstring (max. 2000 Zeichen), Zahl oder Zahlenpaar, ISO-Datum YYYY-MM-DD bzw. Datumspaar, Alter 0–150 oder Liste öffentlicher Tag-IDs. identifier-Vergleiche verlangen passende v2-ID. Kein Feldwert wird allein durch Simulation verändert." } }, "additionalProperties": true, "required": [ "field", "operator" ] }, { "type": "object", "properties": { "combinator": { "type": "string", "description": "and/or (kleingeschrieben normalisiert), Standard and." }, "operator": { "type": "string", "description": "Eingabealias für combinator." }, "conditions": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Kontextfeld aus dem Katalog, z.B. user.email. Kontofelder user.data_fields.data_1 … data_30 nur gemäß account_options." }, "data_type": { "type": "string", "description": "Optional für feste Felder; bei dynamischen Kontofeldern erforderlich und mit dem Kontokatalog abzugleichen (z.B. text/date)." }, "value_type": { "type": "string", "description": "Eingabealias für data_type." }, "operator": { "type": "string", "description": "Operator aus dem Katalog. is_empty/is_not_empty/is_true/is_false benötigen keinen value." }, "value": { "description": "Typ abhängig von Feld/Operator: Textstring (max. 2000 Zeichen), Zahl oder Zahlenpaar, ISO-Datum YYYY-MM-DD bzw. Datumspaar, Alter 0–150 oder Liste öffentlicher Tag-IDs. identifier-Vergleiche verlangen passende v2-ID. Kein Feldwert wird allein durch Simulation verändert." } }, "additionalProperties": true, "required": [ "field", "operator" ] } }, "items": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Kontextfeld aus dem Katalog, z.B. user.email. Kontofelder user.data_fields.data_1 … data_30 nur gemäß account_options." }, "data_type": { "type": "string", "description": "Optional für feste Felder; bei dynamischen Kontofeldern erforderlich und mit dem Kontokatalog abzugleichen (z.B. text/date)." }, "value_type": { "type": "string", "description": "Eingabealias für data_type." }, "operator": { "type": "string", "description": "Operator aus dem Katalog. is_empty/is_not_empty/is_true/is_false benötigen keinen value." }, "value": { "description": "Typ abhängig von Feld/Operator: Textstring (max. 2000 Zeichen), Zahl oder Zahlenpaar, ISO-Datum YYYY-MM-DD bzw. Datumspaar, Alter 0–150 oder Liste öffentlicher Tag-IDs. identifier-Vergleiche verlangen passende v2-ID. Kein Feldwert wird allein durch Simulation verändert." } }, "additionalProperties": true, "required": [ "field", "operator" ] } } }, "additionalProperties": true, "description": "Bedingungsgruppe; höchstens zwei Gruppenebenen und insgesamt 50 Blattbedingungen. Leere Gruppe trifft zu. conditions/items und combinator/operator sind Eingabealiase." } ] } }, "items": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "field": { "type": "string", "description": "Kontextfeld aus dem Katalog, z.B. user.email. Kontofelder user.data_fields.data_1 … data_30 nur gemäß account_options." }, "data_type": { "type": "string", "description": "Optional für feste Felder; bei dynamischen Kontofeldern erforderlich und mit dem Kontokatalog abzugleichen (z.B. text/date)." }, "value_type": { "type": "string", "description": "Eingabealias für data_type." }, "operator": { "type": "string", "description": "Operator aus dem Katalog. is_empty/is_not_empty/is_true/is_false benötigen keinen value." }, "value": { "description": "Typ abhängig von Feld/Operator: Textstring (max. 2000 Zeichen), Zahl oder Zahlenpaar, ISO-Datum YYYY-MM-DD bzw. Datumspaar, Alter 0–150 oder Liste öffentlicher Tag-IDs. identifier-Vergleiche verlangen passende v2-ID. Kein Feldwert wird allein durch Simulation verändert." } }, "additionalProperties": true, "required": [ "field", "operator" ] }, { "type": "object", "properties": { "combinator": { "type": "string", "description": "and/or (kleingeschrieben normalisiert), Standard and." }, "operator": { "type": "string", "description": "Eingabealias für combinator." }, "conditions": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Kontextfeld aus dem Katalog, z.B. user.email. Kontofelder user.data_fields.data_1 … data_30 nur gemäß account_options." }, "data_type": { "type": "string", "description": "Optional für feste Felder; bei dynamischen Kontofeldern erforderlich und mit dem Kontokatalog abzugleichen (z.B. text/date)." }, "value_type": { "type": "string", "description": "Eingabealias für data_type." }, "operator": { "type": "string", "description": "Operator aus dem Katalog. is_empty/is_not_empty/is_true/is_false benötigen keinen value." }, "value": { "description": "Typ abhängig von Feld/Operator: Textstring (max. 2000 Zeichen), Zahl oder Zahlenpaar, ISO-Datum YYYY-MM-DD bzw. Datumspaar, Alter 0–150 oder Liste öffentlicher Tag-IDs. identifier-Vergleiche verlangen passende v2-ID. Kein Feldwert wird allein durch Simulation verändert." } }, "additionalProperties": true, "required": [ "field", "operator" ] } }, "items": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Kontextfeld aus dem Katalog, z.B. user.email. Kontofelder user.data_fields.data_1 … data_30 nur gemäß account_options." }, "data_type": { "type": "string", "description": "Optional für feste Felder; bei dynamischen Kontofeldern erforderlich und mit dem Kontokatalog abzugleichen (z.B. text/date)." }, "value_type": { "type": "string", "description": "Eingabealias für data_type." }, "operator": { "type": "string", "description": "Operator aus dem Katalog. is_empty/is_not_empty/is_true/is_false benötigen keinen value." }, "value": { "description": "Typ abhängig von Feld/Operator: Textstring (max. 2000 Zeichen), Zahl oder Zahlenpaar, ISO-Datum YYYY-MM-DD bzw. Datumspaar, Alter 0–150 oder Liste öffentlicher Tag-IDs. identifier-Vergleiche verlangen passende v2-ID. Kein Feldwert wird allein durch Simulation verändert." } }, "additionalProperties": true, "required": [ "field", "operator" ] } } }, "additionalProperties": true, "description": "Bedingungsgruppe; höchstens zwei Gruppenebenen und insgesamt 50 Blattbedingungen. Leere Gruppe trifft zu. conditions/items und combinator/operator sind Eingabealiase." } ] } } }, "additionalProperties": true, "description": "Bedingungsgruppe; höchstens zwei Gruppenebenen und insgesamt 50 Blattbedingungen. Leere Gruppe trifft zu. conditions/items und combinator/operator sind Eingabealiase." }, { "type": [ "object", "array", "string", "number", "boolean" ] } ], "description": "Normalisierte Definition. Gespeicherte draft/paused-Regeln können trotz erfolgreicher Antwort ungültige Inhalte enthalten; valid und validation_errors beachten." }, "actions": { "type": "array", "items": { "description": "Normalisierte Aktion oder fehlerhafter Entwurfseintrag; Aktivierung erfordert vollständige Validierung.", "anyOf": [ { "type": "object", "additionalProperties": true, "properties": { "type": { "type": "string", "description": "user.update; user.tags.add/remove; email.send_template; note.create; communication.email_template.replace; communication.pdf_template.replace. Verfügbarkeit hängt vom Triggerkontext ab. Eingabealiase email.send sowie communication.*_template.override werden normalisiert." }, "fields": { "type": "object", "minProperties": 1, "additionalProperties": { "type": [ "string", "number", "boolean", "null" ] }, "description": "Offene, kontobezogene Feldwert-Map: user.first_name/last_name/gender/street/postcode/location/country/language/phone_number/email/company oder user.data_fields.data_N. Schreibbare Schlüssel und Typen aus GET /automationrule/catalog übernehmen; Werte müssen scalar oder null sein." }, "tags": { "type": "array", "minItems": 1, "maxItems": 50, "items": { "type": "string", "pattern": "^tag_[a-f0-9]{12}_-?[0-9]+$", "description": "Öffentliche v2-ID aus dem aktuellen Konto." } }, "template": { "type": "string", "pattern": "^et_[a-f0-9]{12}_-?[0-9]+$", "description": "Öffentliche v2-ID aus dem aktuellen Konto." }, "recipient": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "user_field", "offer_leaders" ] }, "field": { "type": "string", "description": "Bei user_field erforderlich: user.email oder textbasiertes user.data_fields.data_N aus account_options.user_email_fields." } }, "additionalProperties": true, "required": [ "type" ] }, "subject": { "type": "string", "maxLength": 255, "description": "Für note.create erforderlich und nach Trim nicht leer." }, "message": { "type": "string", "maxLength": 1000, "default": "" }, "targets": { "type": "array", "items": { "type": "string", "enum": [ "user", "booking" ] }, "minItems": 1, "maxItems": 2, "uniqueItems": true, "description": "Für note.create erforderlich; nur im Trigger vorhandene Kontexte." }, "configuration": { "type": "object", "additionalProperties": true, "description": "Eingabealias: Konfigurationsfelder werden neben type ausgepackt." } } }, { "type": [ "object", "array", "string", "number", "boolean", "null" ] } ] } }, "summary": { "type": "object", "properties": { "conditions": { "type": "integer" }, "actions": { "type": "integer" } }, "additionalProperties": true, "required": [ "conditions", "actions" ] }, "definition_version": { "type": "integer" }, "valid": { "type": "boolean" }, "validation_errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "code": { "type": "string" } }, "additionalProperties": true, "required": [ "path", "code" ] } }, "activated_at": { "type": [ "string", "null" ] }, "created_at": { "type": [ "string", "null" ] }, "updated_at": { "type": [ "string", "null" ] } }, "additionalProperties": true, "required": [ "update", "active", "id", "name", "description", "status", "stored_status", "trigger", "priority", "condition_group", "actions", "summary", "definition_version", "valid", "validation_errors", "activated_at", "created_at", "updated_at" ] }, "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": false, "content": { "application/json": { "schema": { "type": "object", "properties": {}, "additionalProperties": true }, "examples": { "request": { "summary": "Automationsregel aktivieren", "value": {} } } } } }, "x-edoobox-runtimeMutationGuard": true, "x-edoobox-documentationReview": { "file": "docs/openapi/operation-contracts/01-membership.json", "notes": [] }, "x-edoobox-source": { "file": "application/models/v2/Automationrule.php", "method": "postAutomationrule", "line": 74, "branch": { "file": "application/models/v2/Automationrule.php", "line": 94 } }, "x-edoobox-documentationStatus": "reviewed", "x-edoobox-readOnly": false, "x-edoobox-safeForAutomation": false, "x-edoobox-permission": { "resource": "automationrule", "short": "auru", "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." } } ```