POST/v2/emailtemplate/list/add_object

PDF-Datei an einer Vorlage zum Upload reservieren

Reserviert einen PDF-Anhang (type=attachment) oder PDF-Hintergrund (type=pdftemplate) und liefert eine signierte HTTPS-Upload-URL. Der Typ wird aus data.type gelesen, unabhängig vom Segment vor add_object. emailtemplate ist die et_-ID einer vorhandenen Kontovorlage. Anhänge sind nur an E-Mail-Vorlagen erlaubt, höchstens fünf einschließlich offener Reservierungen; PDF-Hintergründe nur an PDF-Vorlagen und höchstens einer. Subscription muss Vorlagen erlauben. Datei anschließend an upload_url hochladen und verify_object aufrufen. file_name endet auf .pdf und ist einschließlich DB-Escaping höchstens 150 Zeichen; tatsächliche Datei wird erst bei verify geprüft.

Operation-ID post_v2_emailtemplate_list_add_object

Vertrag & Verhalten

Dokumentationsstand: reviewed
Ändert Zustand: Ja
Als readOnly markiert: Nein
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: emailtemplate · emtp
Levels: 2, 3, 4
Dispatcher-Prüfung: Ja

Parameter

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`

object

data object erforderlich

emailtemplate string erforderlich

Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID.

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

type Typ nicht eingeschränkt erforderlich

Erlaubte Werte

"attachment""pdftemplate"

file_name string erforderlich

pattern: ".*\\.[pP][dD][fF]$"
maxLength: 150

file_type Typ nicht eingeschränkt erforderlich

Fester Wert: "application/pdf"

file_size integer | string erforderlich

Bytes, numerisch nach int konvertiert. Strikt größer als 20; bei attachment strikt kleiner als 1500000, bei pdftemplate strikt kleiner als 1000000.

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

Vollständiges Schema als JSON

{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "emailtemplate": {
          "type": "string",
          "pattern": "^et_[a-f0-9]{12}_-?[0-9]+$",
          "description": "Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID."
        },
        "type": {
          "enum": [
            "attachment",
            "pdftemplate"
          ]
        },
        "file_name": {
          "type": "string",
          "maxLength": 150,
          "pattern": ".*\\.[pP][dD][fF]$"
        },
        "file_type": {
          "const": "application/pdf"
        },
        "file_size": {
          "type": [
            "integer",
            "string"
          ],
          "description": "Bytes, numerisch nach int konvertiert. Strikt größer als 20; bei attachment strikt kleiner als 1500000, bei pdftemplate strikt kleiner als 1000000."
        }
      },
      "additionalProperties": true,
      "required": [
        "emailtemplate",
        "type",
        "file_name",
        "file_type",
        "file_size"
      ]
    }
  },
  "additionalProperties": true,
  "required": [
    "data"
  ]
}

PDF-Datei an einer Vorlage zum Upload reservieren

{
  "data": {
    "emailtemplate": "et_012345abcdef_123456",
    "type": "attachment",
    "file_name": "Information.pdf",
    "file_type": "application/pdf",
    "file_size": 1200
  }
}

Antworten

HTTP-Status und Antwortinhalt gemeinsam auswerten. In dieser API können auch Antworten mit HTTP 200 einen Fehler enthalten.

200application/json

Neue öffentliche attachment_/pdftemplate_-ID, insert=true und signierte Upload-URL; noch keine verifizierte Datei.

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

id Typ nicht eingeschränkt erforderlich

anyOf · Mindestens eine Variante muss passen

Variante 1 string

Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID.

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

Variante 2 string

Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID.

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

insert boolean erforderlich

upload_url string erforderlich

format: "uri"

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": {
          "anyOf": [
            {
              "type": "string",
              "pattern": "^attachment_[a-f0-9]{12}_-?[0-9]+$",
              "description": "Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID."
            },
            {
              "type": "string",
              "pattern": "^pdftemplate_[a-f0-9]{12}_-?[0-9]+$",
              "description": "Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID."
            }
          ]
        },
        "insert": {
          "type": "boolean"
        },
        "upload_url": {
          "type": "string",
          "format": "uri"
        }
      },
      "additionalProperties": true,
      "required": [
        "id",
        "insert",
        "upload_url"
      ]
    },
    "type": {
      "type": "string"
    }
  },
  "additionalProperties": true
}

Beispiel

{
  "success": true,
  "error": false,
  "data": {
    "id": "attachment_012345abcdef_123456",
    "insert": true,
    "upload_url": "https://example.org/signed-upload"
  }
}

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/Emailtemplate.php:184postEmailtemplate()

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

true

x-edoobox-upload-input-review

{
  "rawFilenameMaxLength": 150,
  "escapedFilenameMaxLength": 150,
  "source": {
    "file": "application/models/v2/Emailtemplatefunc.php",
    "line": 291,
    "sha256": "c25b711ef69b6cf6bb0bd4946a4f2ff0c2467fc1a8cc7a2df48187ddcb9bd60f",
    "lineEnd": 296
  },
  "extensionSource": {
    "file": "application/models/v2/Emailtemplatefunc.php",
    "line": 13,
    "sha256": "c25b711ef69b6cf6bb0bd4946a4f2ff0c2467fc1a8cc7a2df48187ddcb9bd60f",
    "method": "isValidPDFFileName",
    "lineEnd": 18
  }
}

x-edoobox-upload-ticket

{
  "provider": "s3",
  "bucketEnv": "AWS_S3_BUCKET",
  "regionEnv": "AWS_S3_REGION",
  "urlPointer": "/data/upload_url",
  "pathPrefixTemplate": "/ED{fid}F_{appVersion}/mail/",
  "method": "PUT",
  "minBytes": 21,
  "mimeType": "application/pdf",
  "expiresInSeconds": 1800,
  "source": {
    "file": "application/libraries/edoobox/integrations/file/File.php",
    "line": 296
  },
  "maxBytes": 1499999,
  "workflowSelector": {
    "requestPointer": "/body/data/type",
    "variants": {
      "attachment": {
        "metadataCreatedBeforeTransfer": true,
        "requiresApiFinalization": true,
        "scope": "object",
        "finalization": {
          "operationId": "put_v2_emailtemplate_id_verify_object",
          "argumentBindings": [
            {
              "target": "/path/id",
              "source": "/data/id"
            }
          ],
          "scope": "object",
          "after": "successful-storage-transfer"
        },
        "readback": {
          "operationId": "get_v2_emailtemplate_list_attachment",
          "argumentBindings": [
            {
              "target": "/query/filter/0/value",
              "source": "/data/id"
            }
          ],
          "argumentTemplate": {
            "query": {
              "filter": [
                {
                  "property": "id",
                  "expression": "="
                }
              ]
            }
          },
          "proves": "native-verification-record"
        },
        "abort": {
          "operationId": "delete_v2_emailtemplate_id_remove_object",
          "argumentBindings": [
            {
              "target": "/path/id",
              "source": "/data/id"
            }
          ],
          "storageCleanup": "native-delete-attempt"
        },
        "successCriteria": {
          "responsePointers": {
            "/error": false,
            "/data/verify": true
          },
          "readbackRecord": {
            "verify": true
          }
        },
        "notes": [
          "Verify, readback and removal use the newly returned child upload ID, never the parent emailtemplate ID.",
          "Inspect the native error envelope and verification result. A successful storage PUT alone does not finalize the upload.",
          "Abort is a separately reviewed mutation; storage deletion can fail and must not be represented as guaranteed cleanup.",
          "Native deletion does not revoke a previously issued presigned URL. Do not race an in-flight transfer with abort; a late PUT can recreate an orphaned object."
        ]
      },
      "pdftemplate": {
        "metadataCreatedBeforeTransfer": true,
        "requiresApiFinalization": true,
        "scope": "object",
        "finalization": {
          "operationId": "put_v2_emailtemplate_id_verify_object",
          "argumentBindings": [
            {
              "target": "/path/id",
              "source": "/data/id"
            }
          ],
          "scope": "object",
          "after": "successful-storage-transfer"
        },
        "readback": {
          "operationId": "get_v2_emailtemplate_list_pdf_template",
          "argumentBindings": [
            {
              "target": "/query/filter/0/value",
              "source": "/data/id"
            }
          ],
          "argumentTemplate": {
            "query": {
              "filter": [
                {
                  "property": "id",
                  "expression": "="
                }
              ]
            }
          },
          "proves": "native-verification-record"
        },
        "abort": {
          "operationId": "delete_v2_emailtemplate_id_remove_object",
          "argumentBindings": [
            {
              "target": "/path/id",
              "source": "/data/id"
            }
          ],
          "storageCleanup": "native-delete-attempt"
        },
        "successCriteria": {
          "responsePointers": {
            "/error": false,
            "/data/verify": true
          },
          "readbackRecord": {
            "verify": true
          }
        },
        "notes": [
          "Verify, readback and removal use the newly returned child upload ID, never the parent emailtemplate ID.",
          "Inspect the native error envelope and verification result. A successful storage PUT alone does not finalize the upload.",
          "Abort is a separately reviewed mutation; storage deletion can fail and must not be represented as guaranteed cleanup.",
          "Native deletion does not revoke a previously issued presigned URL. Do not race an in-flight transfer with abort; a late PUT can recreate an orphaned object."
        ]
      }
    }
  },
  "workflow": {
    "metadataCreatedBeforeTransfer": true,
    "requiresApiFinalization": true,
    "scope": "object",
    "finalization": {
      "operationId": "put_v2_emailtemplate_id_verify_object",
      "argumentBindings": [
        {
          "target": "/path/id",
          "source": "/data/id"
        }
      ],
      "scope": "object",
      "after": "successful-storage-transfer"
    },
    "readback": {
      "operationId": "get_v2_emailtemplate_list_attachment",
      "argumentBindings": [
        {
          "target": "/query/filter/0/value",
          "source": "/data/id"
        }
      ],
      "argumentTemplate": {
        "query": {
          "filter": [
            {
              "property": "id",
              "expression": "="
            }
          ]
        }
      },
      "proves": "native-verification-record"
    },
    "abort": {
      "operationId": "delete_v2_emailtemplate_id_remove_object",
      "argumentBindings": [
        {
          "target": "/path/id",
          "source": "/data/id"
        }
      ],
      "storageCleanup": "native-delete-attempt"
    },
    "successCriteria": {
      "responsePointers": {
        "/error": false,
        "/data/verify": true
      },
      "readbackRecord": {
        "verify": true
      }
    },
    "notes": [
      "Verify, readback and removal use the newly returned child upload ID, never the parent emailtemplate ID.",
      "Inspect the native error envelope and verification result. A successful storage PUT alone does not finalize the upload.",
      "Abort is a separately reviewed mutation; storage deletion can fail and must not be represented as guaranteed cleanup.",
      "Native deletion does not revoke a previously issued presigned URL. Do not race an in-flight transfer with abort; a late PUT can recreate an orphaned object."
    ]
  }
}

x-edoobox-upload-kind-review

{
  "requestPointer": "/body/data/type",
  "nativeEffectiveByteLimits": {
    "attachment": 1499999,
    "pdftemplate": 999999
  },
  "minimumBytes": 21,
  "ticketCapMeaning": "Union cap; the request schema enforces the per-kind maximum before native metadata creation and the staged transfer must exactly equal that validated file_size. Runtime must choose the reviewed workflow variant from the unchanged validated request, with no URL/default fallback.",
  "sources": [
    {
      "file": "application/models/v2/Emailtemplate.php",
      "line": 184,
      "lineEnd": 193,
      "sha256": "b64dc4fb02c53f520ed472daec7866ba4de3d9c7632f19011ef63bd726721a01",
      "reason": "Any third segment reaching add_object delegates to the same native handler; list is an actual alias."
    },
    {
      "file": "application/models/v2/Emailtemplatefunc.php",
      "line": 9,
      "lineEnd": 26,
      "sha256": "c25b711ef69b6cf6bb0bd4946a4f2ff0c2467fc1a8cc7a2df48187ddcb9bd60f",
      "reason": "Native size predicate requires >20 and excludes1500000 for attachments and1000000 for templates."
    },
    {
      "file": "application/models/v2/Emailtemplatefunc.php",
      "line": 183,
      "lineEnd": 210,
      "sha256": "c25b711ef69b6cf6bb0bd4946a4f2ff0c2467fc1a8cc7a2df48187ddcb9bd60f",
      "reason": "Payload type selects attachment/pdftemplate independently of contextual URL spelling; actual parent ownership remains native."
    },
    {
      "file": "application/models/v2/Emailtemplatefunc.php",
      "line": 298,
      "lineEnd": 357,
      "sha256": "c25b711ef69b6cf6bb0bd4946a4f2ff0c2467fc1a8cc7a2df48187ddcb9bd60f",
      "reason": "Native integer-cast size validation and selected per-body-kind insert/public child response; valid cross-type URL payloads remain valid."
    }
  ]
}

x-edoobox-runtimeMutationGuard

true

x-edoobox-documentationReview

{
  "file": "docs/openapi/operation-contracts/09-messages-ai.json",
  "notes": []
}

x-edoobox-source

{
  "file": "application/models/v2/Emailtemplate.php",
  "method": "postEmailtemplate",
  "line": 184,
  "branch": {
    "file": "application/models/v2/Emailtemplate.php",
    "line": 190
  }
}

x-edoobox-documentationStatus

"reviewed"

x-edoobox-readOnly

false

x-edoobox-safeForAutomation

false

x-edoobox-permission

{
  "resource": "emailtemplate",
  "short": "emtp",
  "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_emailtemplate_list_add_object",
  "summary": "PDF-Datei an einer Vorlage zum Upload reservieren",
  "description": "Reserviert einen PDF-Anhang (type=attachment) oder PDF-Hintergrund (type=pdftemplate) und liefert eine signierte HTTPS-Upload-URL. Der Typ wird aus data.type gelesen, unabhängig vom Segment vor add_object. emailtemplate ist die et_-ID einer vorhandenen Kontovorlage. Anhänge sind nur an E-Mail-Vorlagen erlaubt, höchstens fünf einschließlich offener Reservierungen; PDF-Hintergründe nur an PDF-Vorlagen und höchstens einer. Subscription muss Vorlagen erlauben. Datei anschließend an upload_url hochladen und verify_object aufrufen. file_name endet auf .pdf und ist einschließlich DB-Escaping höchstens 150 Zeichen; tatsächliche Datei wird erst bei verify geprüft.",
  "tags": [
    "emailtemplate"
  ],
  "security": [
    {
      "bearerAuth": [],
      "accountContext": []
    },
    {
      "sessionCookie": [],
      "accountContext": []
    }
  ],
  "parameters": [
    {
      "name": "language",
      "in": "header",
      "required": false,
      "description": "Account language code, where the resource supports setLanguage().",
      "schema": {
        "type": "string",
        "examples": [
          "de"
        ]
      }
    },
    {
      "name": "X-Edoobox-If-Revision",
      "in": "header",
      "required": false,
      "schema": {
        "type": "string",
        "pattern": "^[a-f0-9]{32}$",
        "examples": [
          "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
        ]
      },
      "description": "Optional account mutation revision from a preceding authenticated auth-context snapshot. The dispatcher compares it while holding the account lock; mismatch409 requires a new review."
    }
  ],
  "responses": {
    "200": {
      "description": "Neue öffentliche attachment_/pdftemplate_-ID, insert=true und signierte Upload-URL; noch keine verifizierte Datei.",
      "content": {
        "application/json": {
          "example": {
            "success": true,
            "error": false,
            "data": {
              "id": "attachment_012345abcdef_123456",
              "insert": true,
              "upload_url": "https://example.org/signed-upload"
            }
          },
          "schema": {
            "type": "object",
            "properties": {
              "success": {
                "type": "boolean"
              },
              "error": {
                "type": [
                  "boolean",
                  "string"
                ]
              },
              "error_code": {
                "type": "string"
              },
              "data": {
                "type": "object",
                "properties": {
                  "id": {
                    "anyOf": [
                      {
                        "type": "string",
                        "pattern": "^attachment_[a-f0-9]{12}_-?[0-9]+$",
                        "description": "Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID."
                      },
                      {
                        "type": "string",
                        "pattern": "^pdftemplate_[a-f0-9]{12}_-?[0-9]+$",
                        "description": "Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID."
                      }
                    ]
                  },
                  "insert": {
                    "type": "boolean"
                  },
                  "upload_url": {
                    "type": "string",
                    "format": "uri"
                  }
                },
                "additionalProperties": true,
                "required": [
                  "id",
                  "insert",
                  "upload_url"
                ]
              },
              "type": {
                "type": "string"
              }
            },
            "additionalProperties": true
          }
        }
      },
      "headers": {
        "X-Edoobox-Revision": {
          "schema": {
            "type": "string",
            "pattern": "^[a-f0-9]{32}$"
          },
          "description": "Rotated account revision supplied for the next action in one reviewed sequence."
        }
      }
    },
    "400": {
      "description": "Invalid request.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED40006"
          }
        }
      }
    },
    "401": {
      "description": "Missing/expired token, missing account context, account paused or model-specific authorization failure.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED40103"
          }
        }
      }
    },
    "402": {
      "description": "Missing/invalid action data or subscription/operation restriction.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED80100"
          }
        }
      }
    },
    "403": {
      "description": "Permission denied. Browser CORS rejection may have an empty body.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED40340"
          }
        }
      }
    },
    "404": {
      "description": "Unknown resource/action or unsupported method.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED80019"
          }
        }
      }
    },
    "409": {
      "description": "The account changed after the reviewed read. No domain operation is dispatched; obtain fresh state and review again.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": true
          },
          "example": {
            "error": "ED40901",
            "error_code": "mutation_revision_conflict"
          }
        }
      }
    },
    "422": {
      "description": "Validation failed.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED80020"
          }
        }
      }
    },
    "429": {
      "description": "Request/login rate limit exceeded. Honor Retry-After when supplied; legacy rate-limit paths may omit it. Retry only proven reads within a bounded deadline; a mutation is never automatically replayed after an ambiguous response.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED42902"
          }
        }
      },
      "headers": {
        "Retry-After": {
          "description": "Optional server delay in whole seconds or an HTTP date. Absence is not permission for an immediate retry.",
          "schema": {
            "type": "string",
            "examples": [
              "30"
            ]
          }
        }
      }
    },
    "502": {
      "description": "Server-side operation failed.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED50201"
          }
        }
      }
    },
    "503": {
      "description": "The account mutation lock or revision store is unavailable. No unprotected fallback is executed.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "const": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": true
          },
          "example": {
            "error": "ED50301",
            "error_code": "mutation_revision_busy"
          }
        }
      }
    }
  },
  "x-edoobox-mutates-state": true,
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "properties": {
            "data": {
              "type": "object",
              "properties": {
                "emailtemplate": {
                  "type": "string",
                  "pattern": "^et_[a-f0-9]{12}_-?[0-9]+$",
                  "description": "Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID."
                },
                "type": {
                  "enum": [
                    "attachment",
                    "pdftemplate"
                  ]
                },
                "file_name": {
                  "type": "string",
                  "maxLength": 150,
                  "pattern": ".*\\.[pP][dD][fF]$"
                },
                "file_type": {
                  "const": "application/pdf"
                },
                "file_size": {
                  "type": [
                    "integer",
                    "string"
                  ],
                  "description": "Bytes, numerisch nach int konvertiert. Strikt größer als 20; bei attachment strikt kleiner als 1500000, bei pdftemplate strikt kleiner als 1000000."
                }
              },
              "additionalProperties": true,
              "required": [
                "emailtemplate",
                "type",
                "file_name",
                "file_type",
                "file_size"
              ]
            }
          },
          "additionalProperties": true,
          "required": [
            "data"
          ]
        },
        "examples": {
          "request": {
            "summary": "PDF-Datei an einer Vorlage zum Upload reservieren",
            "value": {
              "data": {
                "emailtemplate": "et_012345abcdef_123456",
                "type": "attachment",
                "file_name": "Information.pdf",
                "file_type": "application/pdf",
                "file_size": 1200
              }
            }
          }
        }
      }
    }
  },
  "x-edoobox-upload-input-review": {
    "rawFilenameMaxLength": 150,
    "escapedFilenameMaxLength": 150,
    "source": {
      "file": "application/models/v2/Emailtemplatefunc.php",
      "line": 291,
      "sha256": "c25b711ef69b6cf6bb0bd4946a4f2ff0c2467fc1a8cc7a2df48187ddcb9bd60f",
      "lineEnd": 296
    },
    "extensionSource": {
      "file": "application/models/v2/Emailtemplatefunc.php",
      "line": 13,
      "sha256": "c25b711ef69b6cf6bb0bd4946a4f2ff0c2467fc1a8cc7a2df48187ddcb9bd60f",
      "method": "isValidPDFFileName",
      "lineEnd": 18
    }
  },
  "x-edoobox-upload-ticket": {
    "provider": "s3",
    "bucketEnv": "AWS_S3_BUCKET",
    "regionEnv": "AWS_S3_REGION",
    "urlPointer": "/data/upload_url",
    "pathPrefixTemplate": "/ED{fid}F_{appVersion}/mail/",
    "method": "PUT",
    "minBytes": 21,
    "mimeType": "application/pdf",
    "expiresInSeconds": 1800,
    "source": {
      "file": "application/libraries/edoobox/integrations/file/File.php",
      "line": 296
    },
    "maxBytes": 1499999,
    "workflowSelector": {
      "requestPointer": "/body/data/type",
      "variants": {
        "attachment": {
          "metadataCreatedBeforeTransfer": true,
          "requiresApiFinalization": true,
          "scope": "object",
          "finalization": {
            "operationId": "put_v2_emailtemplate_id_verify_object",
            "argumentBindings": [
              {
                "target": "/path/id",
                "source": "/data/id"
              }
            ],
            "scope": "object",
            "after": "successful-storage-transfer"
          },
          "readback": {
            "operationId": "get_v2_emailtemplate_list_attachment",
            "argumentBindings": [
              {
                "target": "/query/filter/0/value",
                "source": "/data/id"
              }
            ],
            "argumentTemplate": {
              "query": {
                "filter": [
                  {
                    "property": "id",
                    "expression": "="
                  }
                ]
              }
            },
            "proves": "native-verification-record"
          },
          "abort": {
            "operationId": "delete_v2_emailtemplate_id_remove_object",
            "argumentBindings": [
              {
                "target": "/path/id",
                "source": "/data/id"
              }
            ],
            "storageCleanup": "native-delete-attempt"
          },
          "successCriteria": {
            "responsePointers": {
              "/error": false,
              "/data/verify": true
            },
            "readbackRecord": {
              "verify": true
            }
          },
          "notes": [
            "Verify, readback and removal use the newly returned child upload ID, never the parent emailtemplate ID.",
            "Inspect the native error envelope and verification result. A successful storage PUT alone does not finalize the upload.",
            "Abort is a separately reviewed mutation; storage deletion can fail and must not be represented as guaranteed cleanup.",
            "Native deletion does not revoke a previously issued presigned URL. Do not race an in-flight transfer with abort; a late PUT can recreate an orphaned object."
          ]
        },
        "pdftemplate": {
          "metadataCreatedBeforeTransfer": true,
          "requiresApiFinalization": true,
          "scope": "object",
          "finalization": {
            "operationId": "put_v2_emailtemplate_id_verify_object",
            "argumentBindings": [
              {
                "target": "/path/id",
                "source": "/data/id"
              }
            ],
            "scope": "object",
            "after": "successful-storage-transfer"
          },
          "readback": {
            "operationId": "get_v2_emailtemplate_list_pdf_template",
            "argumentBindings": [
              {
                "target": "/query/filter/0/value",
                "source": "/data/id"
              }
            ],
            "argumentTemplate": {
              "query": {
                "filter": [
                  {
                    "property": "id",
                    "expression": "="
                  }
                ]
              }
            },
            "proves": "native-verification-record"
          },
          "abort": {
            "operationId": "delete_v2_emailtemplate_id_remove_object",
            "argumentBindings": [
              {
                "target": "/path/id",
                "source": "/data/id"
              }
            ],
            "storageCleanup": "native-delete-attempt"
          },
          "successCriteria": {
            "responsePointers": {
              "/error": false,
              "/data/verify": true
            },
            "readbackRecord": {
              "verify": true
            }
          },
          "notes": [
            "Verify, readback and removal use the newly returned child upload ID, never the parent emailtemplate ID.",
            "Inspect the native error envelope and verification result. A successful storage PUT alone does not finalize the upload.",
            "Abort is a separately reviewed mutation; storage deletion can fail and must not be represented as guaranteed cleanup.",
            "Native deletion does not revoke a previously issued presigned URL. Do not race an in-flight transfer with abort; a late PUT can recreate an orphaned object."
          ]
        }
      }
    },
    "workflow": {
      "metadataCreatedBeforeTransfer": true,
      "requiresApiFinalization": true,
      "scope": "object",
      "finalization": {
        "operationId": "put_v2_emailtemplate_id_verify_object",
        "argumentBindings": [
          {
            "target": "/path/id",
            "source": "/data/id"
          }
        ],
        "scope": "object",
        "after": "successful-storage-transfer"
      },
      "readback": {
        "operationId": "get_v2_emailtemplate_list_attachment",
        "argumentBindings": [
          {
            "target": "/query/filter/0/value",
            "source": "/data/id"
          }
        ],
        "argumentTemplate": {
          "query": {
            "filter": [
              {
                "property": "id",
                "expression": "="
              }
            ]
          }
        },
        "proves": "native-verification-record"
      },
      "abort": {
        "operationId": "delete_v2_emailtemplate_id_remove_object",
        "argumentBindings": [
          {
            "target": "/path/id",
            "source": "/data/id"
          }
        ],
        "storageCleanup": "native-delete-attempt"
      },
      "successCriteria": {
        "responsePointers": {
          "/error": false,
          "/data/verify": true
        },
        "readbackRecord": {
          "verify": true
        }
      },
      "notes": [
        "Verify, readback and removal use the newly returned child upload ID, never the parent emailtemplate ID.",
        "Inspect the native error envelope and verification result. A successful storage PUT alone does not finalize the upload.",
        "Abort is a separately reviewed mutation; storage deletion can fail and must not be represented as guaranteed cleanup.",
        "Native deletion does not revoke a previously issued presigned URL. Do not race an in-flight transfer with abort; a late PUT can recreate an orphaned object."
      ]
    }
  },
  "x-edoobox-upload-kind-review": {
    "requestPointer": "/body/data/type",
    "nativeEffectiveByteLimits": {
      "attachment": 1499999,
      "pdftemplate": 999999
    },
    "minimumBytes": 21,
    "ticketCapMeaning": "Union cap; the request schema enforces the per-kind maximum before native metadata creation and the staged transfer must exactly equal that validated file_size. Runtime must choose the reviewed workflow variant from the unchanged validated request, with no URL/default fallback.",
    "sources": [
      {
        "file": "application/models/v2/Emailtemplate.php",
        "line": 184,
        "lineEnd": 193,
        "sha256": "b64dc4fb02c53f520ed472daec7866ba4de3d9c7632f19011ef63bd726721a01",
        "reason": "Any third segment reaching add_object delegates to the same native handler; list is an actual alias."
      },
      {
        "file": "application/models/v2/Emailtemplatefunc.php",
        "line": 9,
        "lineEnd": 26,
        "sha256": "c25b711ef69b6cf6bb0bd4946a4f2ff0c2467fc1a8cc7a2df48187ddcb9bd60f",
        "reason": "Native size predicate requires >20 and excludes1500000 for attachments and1000000 for templates."
      },
      {
        "file": "application/models/v2/Emailtemplatefunc.php",
        "line": 183,
        "lineEnd": 210,
        "sha256": "c25b711ef69b6cf6bb0bd4946a4f2ff0c2467fc1a8cc7a2df48187ddcb9bd60f",
        "reason": "Payload type selects attachment/pdftemplate independently of contextual URL spelling; actual parent ownership remains native."
      },
      {
        "file": "application/models/v2/Emailtemplatefunc.php",
        "line": 298,
        "lineEnd": 357,
        "sha256": "c25b711ef69b6cf6bb0bd4946a4f2ff0c2467fc1a8cc7a2df48187ddcb9bd60f",
        "reason": "Native integer-cast size validation and selected per-body-kind insert/public child response; valid cross-type URL payloads remain valid."
      }
    ]
  },
  "x-edoobox-runtimeMutationGuard": true,
  "x-edoobox-documentationReview": {
    "file": "docs/openapi/operation-contracts/09-messages-ai.json",
    "notes": []
  },
  "x-edoobox-source": {
    "file": "application/models/v2/Emailtemplate.php",
    "method": "postEmailtemplate",
    "line": 184,
    "branch": {
      "file": "application/models/v2/Emailtemplate.php",
      "line": 190
    }
  },
  "x-edoobox-documentationStatus": "reviewed",
  "x-edoobox-readOnly": false,
  "x-edoobox-safeForAutomation": false,
  "x-edoobox-permission": {
    "resource": "emailtemplate",
    "short": "emtp",
    "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.
: "${API_ORIGIN:?API_ORIGIN setzen}"
: "${AUTH_BEARERAUTH:?AUTH_BEARERAUTH setzen}"
: "${AUTH_ACCOUNTCONTEXT:?AUTH_ACCOUNTCONTEXT setzen}"
cat > payload.json <<'EDOOBOX_JSON_EXAMPLE'
{
  "data": {
    "emailtemplate": "et_012345abcdef_123456",
    "type": "attachment",
    "file_name": "Information.pdf",
    "file_type": "application/pdf",
    "file_size": 1200
  }
}
EDOOBOX_JSON_EXAMPLE
curl --request 'POST' \
  --url "${API_ORIGIN%/}"'/v2/emailtemplate/list/add_object' \
  --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/emailtemplate/list/add_object";
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": {
    "emailtemplate": "et_012345abcdef_123456",
    "type": "attachment",
    "file_name": "Information.pdf",
    "file_type": "application/pdf",
    "file_size": 1200
  }
});
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/emailtemplate/list/add_object"
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\":{\"emailtemplate\":\"et_012345abcdef_123456\",\"type\":\"attachment\",\"file_name\":\"Information.pdf\",\"file_type\":\"application/pdf\",\"file_size\":1200}}".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/emailtemplate/list/add_object";
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": {
    "emailtemplate": "et_012345abcdef_123456",
    "type": "attachment",
    "file_name": "Information.pdf",
    "file_type": "application/pdf",
    "file_size": 1200
  }
});
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/emailtemplate/list/add_object"
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\":{\"emailtemplate\":\"et_012345abcdef_123456\",\"type\":\"attachment\",\"file_name\":\"Information.pdf\",\"file_type\":\"application/pdf\",\"file_size\":1200}}".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.