/v2/automationrule/{id}Automationsregel im Detail lesen
Liest die Regel anhand ihrer öffentlichen Pfad-ID. Die Antwort enthält normalisierte Bedingungen/Aktionen, valid und validation_errors. status kann invalid sein, während stored_status den gespeicherten draft/active/paused-Status zeigt. Query-ID, filter, fields und Sortierung werden nicht zur Auswahl verwendet. Regel-/Ausführungszeitstempel werden als ISO-8601-String oder null ausgegeben.
Operation-ID get_v2_automationrule_id
Vertrag & Verhalten
- Dokumentationsstand
- reviewed
- Ändert Zustand
- Nein
- Als readOnly markiert
- Ja
- Für Automation markiert
- Ja
read
Authentifizierung
Eine der folgenden Alternativen muss erfüllt sein (ODER). Innerhalb jeder Alternative werden alle angegebenen Schemas gemeinsam benötigt (UND).
Alternative 1
bearerAuthhttp · bearerExisting edoobox v2 access token. Never substitute API key/secret headers.
Format: JWT
Security-Schema als JSON
{
"type": "http",
"scheme": "bearer",
"bearerFormat": "JWT",
"description": "Existing edoobox v2 access token. Never substitute API key/secret headers."
}accountContextapiKeySelected login/account context from the JWT, not a database primary key. Required even for a JWT with one account.
header: edid
Security-Schema als JSON
{
"type": "apiKey",
"in": "header",
"name": "edid",
"description": "Selected login/account context from the JWT, not a database primary key. Required even for a JWT with one account."
}Alternative 2
sessionCookieapiKeyExisting browser login session, with the same permission checks as Bearer authentication.
cookie: _edlogin
Security-Schema als JSON
{
"type": "apiKey",
"in": "cookie",
"name": "_edlogin",
"description": "Existing browser login session, with the same permission checks as Bearer authentication."
}accountContextapiKeySelected login/account context from the JWT, not a database primary key. Required even for a JWT with one account.
header: edid
Security-Schema als JSON
{
"type": "apiKey",
"in": "header",
"name": "edid",
"description": "Selected login/account context from the JWT, not a database primary key. Required even for a JWT with one account."
}Parameter
Pfadparameter
iderforderlichv2 object identifier in the selected account.
Opaque edoobox v2 object ID returned by this account. Never send a raw database ID. The synthetic example is illustrative and is not a real record.
- pattern
"^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$"
Schema-Beispiel
"automationrule_012345abcdef_123456"Vollständiges Schema als JSON
{
"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"
]
}Header
languageoptionalAccount language code, where the resource supports setLanguage().
Schema-Beispiel
"de"Vollständiges Schema als JSON
{
"type": "string",
"examples": [
"de"
]
}Request Body
Kein Request Body in der Spezifikation beschrieben.
Antworten
9HTTP-Status und Antwortinhalt gemeinsam auswerten. In dieser API können auch Antworten mit HTTP 200 einen Fehler enthalten.
200application/json
data enthält das dokumentierte Ergebnisobjekt bzw. die Ergebnisliste; error=false und success=true.
application/json
success boolean error boolean | string error_code string data object id string erforderlich Öffentliche v2-ID aus dem aktuellen Konto.
- pattern
"^automationrule_[a-f0-9]{12}_-?[0-9]+$"
name string erforderlich description string | null erforderlich status string erforderlich "draft""active""paused""invalid"stored_status string erforderlich "draft""active""paused"trigger string erforderlich priority integer erforderlich condition_group Typ nicht eingeschränkt erforderlich Normalisierte Definition. Gespeicherte draft/paused-Regeln können trotz erfolgreicher Antwort ungültige Inhalte enthalten; valid und validation_errors beachten.
anyOf · Mindestens eine Variante muss passen
Variante 1 object | array | string | number | boolean Bedingungsgruppe; höchstens zwei Gruppenebenen und insgesamt 50 Blattbedingungen. Leere Gruppe trifft zu. conditions/items und combinator/operator sind Eingabealiase.
combinator string and/or (kleingeschrieben normalisiert), Standard and.
operator string Eingabealias für combinator.
conditions array Array-Elemente
anyOf · Mindestens eine Variante muss passen
Variante 1 object field string erforderlich Kontextfeld aus dem Katalog, z.B. user.email. Kontofelder user.data_fields.data_1 … data_30 nur gemäß account_options.
data_type string Optional für feste Felder; bei dynamischen Kontofeldern erforderlich und mit dem Kontokatalog abzugleichen (z.B. text/date).
value_type string Eingabealias für data_type.
operator string erforderlich Operator aus dem Katalog. is_empty/is_not_empty/is_true/is_false benötigen keinen value.
value Typ nicht eingeschränkt 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.
Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
Variante 2 object Bedingungsgruppe; höchstens zwei Gruppenebenen und insgesamt 50 Blattbedingungen. Leere Gruppe trifft zu. conditions/items und combinator/operator sind Eingabealiase.
combinator string and/or (kleingeschrieben normalisiert), Standard and.
operator string Eingabealias für combinator.
conditions array Array-Elemente
field string erforderlich Kontextfeld aus dem Katalog, z.B. user.email. Kontofelder user.data_fields.data_1 … data_30 nur gemäß account_options.
data_type string Optional für feste Felder; bei dynamischen Kontofeldern erforderlich und mit dem Kontokatalog abzugleichen (z.B. text/date).
value_type string Eingabealias für data_type.
operator string erforderlich Operator aus dem Katalog. is_empty/is_not_empty/is_true/is_false benötigen keinen value.
value Typ nicht eingeschränkt 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.
Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
items array Array-Elemente
field string erforderlich Kontextfeld aus dem Katalog, z.B. user.email. Kontofelder user.data_fields.data_1 … data_30 nur gemäß account_options.
data_type string Optional für feste Felder; bei dynamischen Kontofeldern erforderlich und mit dem Kontokatalog abzugleichen (z.B. text/date).
value_type string Eingabealias für data_type.
operator string erforderlich Operator aus dem Katalog. is_empty/is_not_empty/is_true/is_false benötigen keinen value.
value Typ nicht eingeschränkt 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.
Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
items array Array-Elemente
anyOf · Mindestens eine Variante muss passen
Variante 1 object field string erforderlich Kontextfeld aus dem Katalog, z.B. user.email. Kontofelder user.data_fields.data_1 … data_30 nur gemäß account_options.
data_type string Optional für feste Felder; bei dynamischen Kontofeldern erforderlich und mit dem Kontokatalog abzugleichen (z.B. text/date).
value_type string Eingabealias für data_type.
operator string erforderlich Operator aus dem Katalog. is_empty/is_not_empty/is_true/is_false benötigen keinen value.
value Typ nicht eingeschränkt 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.
Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
Variante 2 object Bedingungsgruppe; höchstens zwei Gruppenebenen und insgesamt 50 Blattbedingungen. Leere Gruppe trifft zu. conditions/items und combinator/operator sind Eingabealiase.
combinator string and/or (kleingeschrieben normalisiert), Standard and.
operator string Eingabealias für combinator.
conditions array Array-Elemente
field string erforderlich Kontextfeld aus dem Katalog, z.B. user.email. Kontofelder user.data_fields.data_1 … data_30 nur gemäß account_options.
data_type string Optional für feste Felder; bei dynamischen Kontofeldern erforderlich und mit dem Kontokatalog abzugleichen (z.B. text/date).
value_type string Eingabealias für data_type.
operator string erforderlich Operator aus dem Katalog. is_empty/is_not_empty/is_true/is_false benötigen keinen value.
value Typ nicht eingeschränkt 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.
Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
items array Array-Elemente
field string erforderlich Kontextfeld aus dem Katalog, z.B. user.email. Kontofelder user.data_fields.data_1 … data_30 nur gemäß account_options.
data_type string Optional für feste Felder; bei dynamischen Kontofeldern erforderlich und mit dem Kontokatalog abzugleichen (z.B. text/date).
value_type string Eingabealias für data_type.
operator string erforderlich Operator aus dem Katalog. is_empty/is_not_empty/is_true/is_false benötigen keinen value.
value Typ nicht eingeschränkt 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.
Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
Variante 2 object | array | string | number | boolean actions array erforderlich Array-Elemente
Normalisierte Aktion oder fehlerhafter Entwurfseintrag; Aktivierung erfordert vollständige Validierung.
anyOf · Mindestens eine Variante muss passen
Variante 1 object type string 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 object 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.
- minProperties
1
Schema für zusätzliche Felder
tags array - minItems
1- maxItems
50
Array-Elemente
Öffentliche v2-ID aus dem aktuellen Konto.
- pattern
"^tag_[a-f0-9]{12}_-?[0-9]+$"
template string Öffentliche v2-ID aus dem aktuellen Konto.
- pattern
"^et_[a-f0-9]{12}_-?[0-9]+$"
recipient object type string erforderlich "user_field""offer_leaders"field string Bei user_field erforderlich: user.email oder textbasiertes user.data_fields.data_N aus account_options.user_email_fields.
Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
subject string Für note.create erforderlich und nach Trim nicht leer.
- maxLength
255
message string - maxLength
1000
Standardwert: ""
targets array Für note.create erforderlich; nur im Trigger vorhandene Kontexte.
- minItems
1- maxItems
2- uniqueItems
true
Array-Elemente
"user""booking"configuration object Eingabealias: Konfigurationsfelder werden neben type ausgepackt.
Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
Variante 2 object | array | string | number | boolean | null summary object erforderlich conditions integer erforderlich actions integer erforderlich Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
definition_version integer erforderlich valid boolean erforderlich validation_errors array erforderlich Array-Elemente
path string erforderlich code string erforderlich Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
activated_at string | null erforderlich created_at string | null erforderlich updated_at string | null erforderlich Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
type string Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
Vollständiges Schema als JSON
{
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"error": {
"type": [
"boolean",
"string"
]
},
"error_code": {
"type": "string"
},
"data": {
"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
}Beispiel
{
"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"
}
}400application/json
Invalid request.
application/json
Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.
Beispiel
{
"success": false,
"error": "ED40006"
}401application/json
Missing/expired token, missing account context, account paused or model-specific authorization failure.
application/json
Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.
Beispiel
{
"success": false,
"error": "ED40103"
}402application/json
Missing/invalid action data or subscription/operation restriction.
application/json
Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.
Beispiel
{
"success": false,
"error": "ED80100"
}403application/json
Permission denied. Browser CORS rejection may have an empty body.
application/json
Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.
Beispiel
{
"success": false,
"error": "ED40340"
}404application/json
Unknown resource/action or unsupported method.
application/json
Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.
Beispiel
{
"success": false,
"error": "ED80019"
}422application/json
Validation failed.
application/json
Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.
Beispiel
{
"success": false,
"error": "ED80020"
}429application/json
Request/login rate limit exceeded. Honor Retry-After when supplied; legacy rate-limit paths may omit it. Retry only proven reads within a bounded deadline; a mutation is never automatically replayed after an ambiguous response.
Response Header
Retry-After
Optional server delay in whole seconds or an HTTP date. Absence is not permission for an immediate retry.
Schema-Beispiel
"30"Vollständiges Schema als JSON
{
"type": "string",
"examples": [
"30"
]
}application/json
Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.
Beispiel
{
"success": false,
"error": "ED42902"
}502application/json
Server-side operation failed.
application/json
Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.
Beispiel
{
"success": false,
"error": "ED50201"
}Quelle & Metadaten
application/models/v2/Automationrule.php:38getAutomationrule()Diese Angaben stammen unverändert aus der gelieferten OpenAPI-Datei. Zusätzliche Freigaben, Vorbedingungen, sensible Felder und Hinweise stehen in den Erweiterungen.
x-edoobox-mutates-state
falsex-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
falsex-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
truex-edoobox-safeForAutomation
truex-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."
}Vollständige Operation als JSON
{
"operationId": "get_v2_automationrule_id",
"summary": "Automationsregel im Detail lesen",
"description": "Liest die Regel anhand ihrer öffentlichen Pfad-ID. Die Antwort enthält normalisierte Bedingungen/Aktionen, valid und validation_errors. status kann invalid sein, während stored_status den gespeicherten draft/active/paused-Status zeigt. Query-ID, filter, fields und Sortierung werden nicht zur Auswahl verwendet. 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"
]
}
}
],
"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": "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."
}
}