POST/v2/automationrule/{id}/simulate

Automationsregel an einem Kontoobjekt simulieren

Wertet die gespeicherte Regel an einem existierenden Kontoobjekt aus. resource_id ist bei gültiger Regel erforderlich und muss zum Trigger passen; Vorlagen/Tags/Felder werden zuvor validiert. Bei ungültiger Regel folgt matched=false mit validation.errors und trace=null, bevor resource_id geprüft wird. Liefert Treffer, wertfreie Auswertungsspur und nur bei Treffer die geplanten Aktionen; führt keine Aktionen aus und legt keinen Ausführungseintrag an. /test ist derselbe reine Simulationspfad. Regel-/Ausführungszeitstempel werden als ISO-8601-String oder null ausgegeben.

Operation-ID post_v2_automationrule_id_simulate

Vertrag & Verhalten

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

Authentifizierung

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

Alternative 1

bearerAuthhttp · bearer

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

Format: JWT

Security-Schema als JSON

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

accountContextapiKey

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

header: edid

Security-Schema als JSON

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

Alternative 2

sessionCookieapiKey

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

cookie: _edlogin

Security-Schema als JSON

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

accountContextapiKey

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

header: edid

Security-Schema als JSON

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

Berechtigungen

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

Ressource: automationrule · auru
Levels: 2, 3, 4
Dispatcher-Prüfung: Ja

Parameter

Pfadparameter

iderforderlich

v2 object identifier in the selected account.

string

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

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

Schema-Beispiel

"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

languageoptional

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

string

Schema-Beispiel

"de"

Vollständiges Schema als JSON

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

X-Edoobox-If-Revisionoptional

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

string

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

Schema-Beispiel

"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

Vollständiges Schema als JSON

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

Request Body

erforderlich

`application/json`

Typ nicht eingeschränkt

anyOf · Mindestens eine Variante muss passen

Variante 1 object

data object erforderlich

resource_id string erforderlich

Öffentliche ID eines Kontoobjekts passend zum Trigger: api.post.user→user, api.post.booking/booking_confirmation→booking, api.post.offer→offer, certificate→participant. Kein künstliches Ereignis wird gespeichert.

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

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

Variante 2 object

resource_id string erforderlich

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

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

Vollständiges Schema als JSON

{
  "anyOf": [
    {
      "type": "object",
      "properties": {
        "data": {
          "type": "object",
          "properties": {
            "resource_id": {
              "type": "string",
              "pattern": "^(?:user|booking|offer|participant)_[a-f0-9]{12}_-?[0-9]+$",
              "description": "Öffentliche ID eines Kontoobjekts passend zum Trigger: api.post.user→user, api.post.booking/booking_confirmation→booking, api.post.offer→offer, certificate→participant. Kein künstliches Ereignis wird gespeichert."
            }
          },
          "additionalProperties": true,
          "required": [
            "resource_id"
          ]
        }
      },
      "additionalProperties": true,
      "required": [
        "data"
      ]
    },
    {
      "type": "object",
      "properties": {
        "resource_id": {
          "type": "string",
          "pattern": "^(?:user|booking|offer|participant)_[a-f0-9]{12}_-?[0-9]+$",
          "description": "Öffentliche ID eines Kontoobjekts passend zum Trigger: api.post.user→user, api.post.booking/booking_confirmation→booking, api.post.offer→offer, certificate→participant. Kein künstliches Ereignis wird gespeichert."
        }
      },
      "additionalProperties": true,
      "required": [
        "resource_id"
      ]
    }
  ]
}

Automationsregel an einem Kontoobjekt simulieren

{
  "data": {
    "resource_id": "user_012345abcdef_123456"
  }
}

Antworten

HTTP-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.

Response Header

`X-Edoobox-Revision`

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

string

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

Vollständiges Schema als JSON

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

`application/json`

object

success boolean

error boolean | string

error_code string

data object

matched boolean erforderlich

trigger string erforderlich

validation object erforderlich

valid boolean erforderlich

errors array erforderlich

Array-Elemente

object

path string erforderlich

code string erforderlich

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

trace Typ nicht eingeschränkt erforderlich

anyOf · Mindestens eine Variante muss passen

Variante 1 object

type string

field string

operator string

field_exists boolean

result boolean

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

Variante 2 object

type string

combinator string

result boolean

children array

Array-Elemente

object

Weitere Gruppen- oder Bedingungsspur ohne tatsächliche Feldwerte.

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

Variante 3 null

actions array erforderlich

Array-Elemente

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

string | number | boolean | null

tags array

minItems: 1
maxItems: 50

Array-Elemente

string

Ö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

Erlaubte Werte

"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

string

Erlaubte Werte

"user""booking"

configuration object

Eingabealias: Konfigurationsfelder werden neben type ausgepackt.

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

valid boolean

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": {
        "matched": {
          "type": "boolean"
        },
        "trigger": {
          "type": "string"
        },
        "validation": {
          "type": "object",
          "properties": {
            "valid": {
              "type": "boolean"
            },
            "errors": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "path": {
                    "type": "string"
                  },
                  "code": {
                    "type": "string"
                  }
                },
                "additionalProperties": true,
                "required": [
                  "path",
                  "code"
                ]
              }
            }
          },
          "additionalProperties": true,
          "required": [
            "valid",
            "errors"
          ]
        },
        "trace": {
          "anyOf": [
            {
              "type": "object",
              "properties": {
                "type": {
                  "type": "string"
                },
                "field": {
                  "type": "string"
                },
                "operator": {
                  "type": "string"
                },
                "field_exists": {
                  "type": "boolean"
                },
                "result": {
                  "type": "boolean"
                }
              },
              "additionalProperties": true
            },
            {
              "type": "object",
              "properties": {
                "type": {
                  "type": "string"
                },
                "combinator": {
                  "type": "string"
                },
                "result": {
                  "type": "boolean"
                },
                "children": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "additionalProperties": true,
                    "description": "Weitere Gruppen- oder Bedingungsspur ohne tatsächliche Feldwerte."
                  }
                }
              },
              "additionalProperties": true
            },
            {
              "type": "null"
            }
          ]
        },
        "actions": {
          "type": "array",
          "items": {
            "type": "object",
            "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."
              },
              "valid": {
                "type": "boolean"
              }
            },
            "additionalProperties": true
          }
        }
      },
      "additionalProperties": true,
      "required": [
        "matched",
        "trigger",
        "validation",
        "trace",
        "actions"
      ]
    },
    "type": {
      "type": "string"
    }
  },
  "additionalProperties": true
}

Beispiel

{
  "success": true,
  "error": false,
  "data": {
    "matched": true,
    "trigger": "api.post.user",
    "validation": {
      "valid": true,
      "errors": []
    },
    "trace": {
      "type": "group",
      "combinator": "and",
      "result": true,
      "children": []
    },
    "actions": [
      {
        "type": "note.create",
        "subject": "Neuer Kunde aus API",
        "message": "Datensatz prüfen",
        "targets": [
          "user"
        ],
        "valid": true
      }
    ]
  }
}

400application/json

Invalid request.

`application/json`

Typ nicht eingeschränkt

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

Beispiel

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

401application/json

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

`application/json`

Typ nicht eingeschränkt

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

Beispiel

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

402application/json

Missing/invalid action data or subscription/operation restriction.

`application/json`

Typ nicht eingeschränkt

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

Beispiel

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

403application/json

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

`application/json`

Typ nicht eingeschränkt

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

Beispiel

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

404application/json

Unknown resource/action or unsupported method.

`application/json`

Typ nicht eingeschränkt

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

Beispiel

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

409application/json

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

`application/json`

object

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

Vollständiges Schema als JSON

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

Beispiel

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

422application/json

Validation failed.

`application/json`

Typ nicht eingeschränkt

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

Beispiel

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

429application/json

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

Response Header

`Retry-After`

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

string

Schema-Beispiel

"30"

Vollständiges Schema als JSON

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

`application/json`

Typ nicht eingeschränkt

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

Beispiel

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

502application/json

Server-side operation failed.

`application/json`

Typ nicht eingeschränkt

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

Beispiel

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

503application/json

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

Response Header

`application/json`

object

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

Vollständiges Schema als JSON

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

Beispiel

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

Quelle & Metadaten

Quelle laut Spezifikationapplication/models/v2/Automationrule.php:74postAutomationrule()

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

false

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": 93
  }
}

x-edoobox-documentationStatus

"reviewed"

x-edoobox-readOnly

true

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."
}

Vollständige Operation als JSON

{
  "operationId": "post_v2_automationrule_id_simulate",
  "summary": "Automationsregel an einem Kontoobjekt simulieren",
  "description": "Wertet die gespeicherte Regel an einem existierenden Kontoobjekt aus. resource_id ist bei gültiger Regel erforderlich und muss zum Trigger passen; Vorlagen/Tags/Felder werden zuvor validiert. Bei ungültiger Regel folgt matched=false mit validation.errors und trace=null, bevor resource_id geprüft wird. Liefert Treffer, wertfreie Auswertungsspur und nur bei Treffer die geplanten Aktionen; führt keine Aktionen aus und legt keinen Ausführungseintrag an. /test ist derselbe reine Simulationspfad. 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": {
              "matched": true,
              "trigger": "api.post.user",
              "validation": {
                "valid": true,
                "errors": []
              },
              "trace": {
                "type": "group",
                "combinator": "and",
                "result": true,
                "children": []
              },
              "actions": [
                {
                  "type": "note.create",
                  "subject": "Neuer Kunde aus API",
                  "message": "Datensatz prüfen",
                  "targets": [
                    "user"
                  ],
                  "valid": true
                }
              ]
            }
          },
          "schema": {
            "type": "object",
            "properties": {
              "success": {
                "type": "boolean"
              },
              "error": {
                "type": [
                  "boolean",
                  "string"
                ]
              },
              "error_code": {
                "type": "string"
              },
              "data": {
                "type": "object",
                "properties": {
                  "matched": {
                    "type": "boolean"
                  },
                  "trigger": {
                    "type": "string"
                  },
                  "validation": {
                    "type": "object",
                    "properties": {
                      "valid": {
                        "type": "boolean"
                      },
                      "errors": {
                        "type": "array",
                        "items": {
                          "type": "object",
                          "properties": {
                            "path": {
                              "type": "string"
                            },
                            "code": {
                              "type": "string"
                            }
                          },
                          "additionalProperties": true,
                          "required": [
                            "path",
                            "code"
                          ]
                        }
                      }
                    },
                    "additionalProperties": true,
                    "required": [
                      "valid",
                      "errors"
                    ]
                  },
                  "trace": {
                    "anyOf": [
                      {
                        "type": "object",
                        "properties": {
                          "type": {
                            "type": "string"
                          },
                          "field": {
                            "type": "string"
                          },
                          "operator": {
                            "type": "string"
                          },
                          "field_exists": {
                            "type": "boolean"
                          },
                          "result": {
                            "type": "boolean"
                          }
                        },
                        "additionalProperties": true
                      },
                      {
                        "type": "object",
                        "properties": {
                          "type": {
                            "type": "string"
                          },
                          "combinator": {
                            "type": "string"
                          },
                          "result": {
                            "type": "boolean"
                          },
                          "children": {
                            "type": "array",
                            "items": {
                              "type": "object",
                              "additionalProperties": true,
                              "description": "Weitere Gruppen- oder Bedingungsspur ohne tatsächliche Feldwerte."
                            }
                          }
                        },
                        "additionalProperties": true
                      },
                      {
                        "type": "null"
                      }
                    ]
                  },
                  "actions": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "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."
                        },
                        "valid": {
                          "type": "boolean"
                        }
                      },
                      "additionalProperties": true
                    }
                  }
                },
                "additionalProperties": true,
                "required": [
                  "matched",
                  "trigger",
                  "validation",
                  "trace",
                  "actions"
                ]
              },
              "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": false,
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "anyOf": [
            {
              "type": "object",
              "properties": {
                "data": {
                  "type": "object",
                  "properties": {
                    "resource_id": {
                      "type": "string",
                      "pattern": "^(?:user|booking|offer|participant)_[a-f0-9]{12}_-?[0-9]+$",
                      "description": "Öffentliche ID eines Kontoobjekts passend zum Trigger: api.post.user→user, api.post.booking/booking_confirmation→booking, api.post.offer→offer, certificate→participant. Kein künstliches Ereignis wird gespeichert."
                    }
                  },
                  "additionalProperties": true,
                  "required": [
                    "resource_id"
                  ]
                }
              },
              "additionalProperties": true,
              "required": [
                "data"
              ]
            },
            {
              "type": "object",
              "properties": {
                "resource_id": {
                  "type": "string",
                  "pattern": "^(?:user|booking|offer|participant)_[a-f0-9]{12}_-?[0-9]+$",
                  "description": "Öffentliche ID eines Kontoobjekts passend zum Trigger: api.post.user→user, api.post.booking/booking_confirmation→booking, api.post.offer→offer, certificate→participant. Kein künstliches Ereignis wird gespeichert."
                }
              },
              "additionalProperties": true,
              "required": [
                "resource_id"
              ]
            }
          ]
        },
        "examples": {
          "request": {
            "summary": "Automationsregel an einem Kontoobjekt simulieren",
            "value": {
              "data": {
                "resource_id": "user_012345abcdef_123456"
              }
            }
          }
        }
      }
    }
  },
  "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": 93
    }
  },
  "x-edoobox-documentationStatus": "reviewed",
  "x-edoobox-readOnly": true,
  "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."
  }
}

Aufruf vorbereiten

Beispiel

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

cURL

# Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich.
# Request Body: synthetisches Beispiel aus der Spezifikation; Werte und Vollständigkeit vor Verwendung prüfen.
# 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'
{
  "data": {
    "resource_id": "user_012345abcdef_123456"
  }
}
EDOOBOX_JSON_EXAMPLE
curl --request 'POST' \
  --url "${API_ORIGIN%/}"'/v2/automationrule/'"${PATH_ID}"'/simulate' \
  --header 'Authorization: Bearer '"${AUTH_BEARERAUTH}" \
  --header 'edid: '"${AUTH_ACCOUNTCONTEXT}" \
  --header 'Content-Type: application/json' \
  --data-binary '@payload.json'

JavaScript

// Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich.
// Request Body: synthetisches Beispiel aus der Spezifikation; Werte und Vollständigkeit vor Verwendung prüfen.
const required = (name) => {
  const value = process.env[name];
  if (!value) throw new Error(`Set ${name}`);
  return value;
};
let path = "/v2/automationrule/{id}/simulate";
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({
  "data": {
    "resource_id": "user_012345abcdef_123456"
  }
});
const response = await fetch(url, { method: "POST", headers, body, redirect: 'manual' });
const text = await response.text();
console.log(response.status, text);
// HTTP-Status und dokumentierte error/success-Felder gemeinsam prüfen.

Python

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

path = "/v2/automationrule/{id}/simulate"
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 = "{\"data\":{\"resource_id\":\"user_012345abcdef_123456\"}}".encode("utf-8")

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

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

JavaScript

// Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich.
// Request Body: synthetisches Beispiel aus der Spezifikation; Werte und Vollständigkeit vor Verwendung prüfen.
const required = (name) => {
  const value = process.env[name];
  if (!value) throw new Error(`Set ${name}`);
  return value;
};
let path = "/v2/automationrule/{id}/simulate";
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({
  "data": {
    "resource_id": "user_012345abcdef_123456"
  }
});
const response = await fetch(url, { method: "POST", headers, body, redirect: 'manual' });
const text = await response.text();
console.log(response.status, text);
// HTTP-Status und dokumentierte error/success-Felder gemeinsam prüfen.

Python

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

path = "/v2/automationrule/{id}/simulate"
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 = "{\"data\":{\"resource_id\":\"user_012345abcdef_123456\"}}".encode("utf-8")

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

Server aus der Spezifikation

https://app2.edoobox.com

edoobox API

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

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