# GET /v2/automationrule Automationsregeln suchen Liest nicht gelöschte Regeln des Kontos mit Definition, Validierungsfehlern und effektivem Status. status=invalid sucht gespeicherte Definitionsfehler, sonst draft/active/paused nur gültige Regeln. Optional trigger und search in Name/Beschreibung; unbekannte status/trigger werden ignoriert. Reihenfolge updated_at und ID absteigend. meta und limit enthalten total, reply/limit und start/offset. Pagination nur per limit.start/reply; ein separates offset greift nach Dispatcher-Normalisierung nicht. Regel-/Ausführungszeitstempel werden als ISO-8601-String oder null ausgegeben. - Operation-ID: get_v2_automationrule - Dokumentation: /docs/api/v2/operations/get-v2-automationrule-04b9bbece2c0/ - OpenAPI-Version: 3.2.1 - Vollständige Spezifikation: /docs/api/v2/openapi.json - Dokumentationsstatus: reviewed - Ändert Zustand: nein, gemäss Annotation - Für Automation freigegeben: ja, siehe Voraussetzungen ## 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 | | --- | --- | --- | --- | | limit | query | nein | JSON-Objekt start/reply oder Zahl als reply; Standard Offset 0, reply 100. Tatsächliche Seitengröße wird auf 1–200 begrenzt. | | trigger | query | nein | Auslöser; bestimmt verfügbare Kontextfelder und Aktionen. | | search | query | nein | Teiltext in Name oder Beschreibung. | | status | query | nein | Effektiver Statusfilter. | | language | header | nein | Account language code, where the resource supports setLanguage(). | ### Vollständige wirksame Parameterdefinitionen ```json [ { "name": "limit", "in": "query", "required": false, "description": "JSON-Objekt start/reply oder Zahl als reply; Standard Offset 0, reply 100. Tatsächliche Seitengröße wird auf 1–200 begrenzt.", "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "default": 0 }, "reply": { "type": "integer", "minimum": 1, "maximum": 200, "default": 100 } }, "additionalProperties": true }, { "type": "integer", "minimum": 1, "maximum": 200 } ] }, "example": { "start": 0, "reply": 25 } } } }, { "name": "trigger", "in": "query", "required": false, "description": "Auslöser; bestimmt verfügbare Kontextfelder und Aktionen.", "schema": { "type": "string", "enum": [ "api.post.user", "api.post.booking", "api.post.offer", "communication.booking_confirmation.before_send", "communication.certificate.before_send" ] } }, { "name": "search", "in": "query", "required": false, "description": "Teiltext in Name oder Beschreibung.", "schema": { "type": "string" } }, { "name": "status", "in": "query", "required": false, "description": "Effektiver Statusfilter.", "schema": { "type": "string", "enum": [ "draft", "active", "paused", "invalid" ] } }, { "name": "language", "in": "header", "required": false, "description": "Account language code, where the resource supports setLanguage().", "schema": { "type": "string", "examples": [ "de" ] } } ] ``` ## Anfrage Kein Request Body deklariert. ## 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": [ { "id": "automationrule_012345abcdef_123456", "name": "Neue Kunden begrüßen", "description": "Notiz nach API-Erstellung", "status": "draft", "stored_status": "draft", "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": null, "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": "array", "items": { "type": "object", "properties": { "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": [ "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 } } } }, "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" } } } }, "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" } } } } } ``` ## 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. : "${API_ORIGIN:?API_ORIGIN setzen}" : "${AUTH_BEARERAUTH:?AUTH_BEARERAUTH setzen}" : "${AUTH_ACCOUNTCONTEXT:?AUTH_ACCOUNTCONTEXT setzen}" curl --request 'GET' \ --url "${API_ORIGIN%/}"'/v2/automationrule' \ --header 'Authorization: Bearer '"${AUTH_BEARERAUTH}" \ --header 'edid: '"${AUTH_ACCOUNTCONTEXT}" ``` ### JavaScript (Node.js) ```javascript // Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich. const required = (name) => { const value = process.env[name]; if (!value) throw new Error(`Set ${name}`); return value; }; let path = "/v2/automationrule"; 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"); const response = await fetch(url, { method: "GET", headers, 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. import os import urllib.parse import urllib.request import urllib.error path = "/v2/automationrule" url = os.environ["API_ORIGIN"].rstrip("/") + path headers = {} headers["Authorization"] = "Bearer " + os.environ["AUTH_BEARERAUTH"] headers["edid"] = "" + os.environ["AUTH_ACCOUNTCONTEXT"] # 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="GET") 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": "get_v2_automationrule", "summary": "Automationsregeln suchen", "description": "Liest nicht gelöschte Regeln des Kontos mit Definition, Validierungsfehlern und effektivem Status. status=invalid sucht gespeicherte Definitionsfehler, sonst draft/active/paused nur gültige Regeln. Optional trigger und search in Name/Beschreibung; unbekannte status/trigger werden ignoriert. Reihenfolge updated_at und ID absteigend. meta und limit enthalten total, reply/limit und start/offset. Pagination nur per limit.start/reply; ein separates offset greift nach Dispatcher-Normalisierung nicht. Regel-/Ausführungszeitstempel werden als ISO-8601-String oder null ausgegeben.", "tags": [ "automationrule" ], "security": [ { "bearerAuth": [], "accountContext": [] }, { "sessionCookie": [], "accountContext": [] } ], "parameters": [ { "name": "limit", "in": "query", "required": false, "description": "JSON-Objekt start/reply oder Zahl als reply; Standard Offset 0, reply 100. Tatsächliche Seitengröße wird auf 1–200 begrenzt.", "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "default": 0 }, "reply": { "type": "integer", "minimum": 1, "maximum": 200, "default": 100 } }, "additionalProperties": true }, { "type": "integer", "minimum": 1, "maximum": 200 } ] }, "example": { "start": 0, "reply": 25 } } } }, { "name": "trigger", "in": "query", "required": false, "description": "Auslöser; bestimmt verfügbare Kontextfelder und Aktionen.", "schema": { "type": "string", "enum": [ "api.post.user", "api.post.booking", "api.post.offer", "communication.booking_confirmation.before_send", "communication.certificate.before_send" ] } }, { "name": "search", "in": "query", "required": false, "description": "Teiltext in Name oder Beschreibung.", "schema": { "type": "string" } }, { "name": "status", "in": "query", "required": false, "description": "Effektiver Statusfilter.", "schema": { "type": "string", "enum": [ "draft", "active", "paused", "invalid" ] } }, { "name": "language", "in": "header", "required": false, "description": "Account language code, where the resource supports setLanguage().", "schema": { "type": "string", "examples": [ "de" ] } } ], "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": [ { "id": "automationrule_012345abcdef_123456", "name": "Neue Kunden begrüßen", "description": "Notiz nach API-Erstellung", "status": "draft", "stored_status": "draft", "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": null, "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": "array", "items": { "type": "object", "properties": { "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": [ "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 } } } }, "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" } } } }, "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" } } } } }, "x-edoobox-mutates-state": false, "x-edoobox-mutationReview": { "source": { "file": "application/models/v2/Automationrule.php", "line": 38 }, "reason": "Read rules, existing execution history or static catalog/samples; no execution is started." }, "x-edoobox-runtimeMutationGuard": false, "x-edoobox-get-effect": "read", "x-edoobox-documentationReview": { "file": "docs/openapi/operation-contracts/01-membership.json", "notes": [] }, "x-edoobox-source": { "file": "application/models/v2/Automationrule.php", "method": "getAutomationrule", "line": 38 }, "x-edoobox-documentationStatus": "reviewed", "x-edoobox-readOnly": true, "x-edoobox-safeForAutomation": true, "x-edoobox-permission": { "resource": "automationrule", "short": "auru", "checkedByDispatcher": true, "levels": [ 1, 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." } } ```