Datei für eine Mail hochladen
Benötigte Berechtigung:mail:send(E-Mails senden)
Echte Wirkung
/api/document-mail/attachmentsKein Testversand aus der Dokumentation: Jeder Aufruf legt einen echten Beleg an. Nutze das Codebeispiel mit einer Datei, die wirklich in die Firma gehört.
Speichert eine Datei, die du danach mit attachments an previewDocumentMail und sendDocumentMail übergibst, als {"uploadId": …}. Die Datei wird kein Beleg und taucht nirgends sonst auf; bimetrics löscht sie nicht von selbst. Den Typ erkennt bimetrics am Inhalt: Ein PNG namens Lageplan.pdf heißt danach Lageplan.png. Andere Typen: 400 DocumentMailAttachmentType, größer als 10 MiB: 400 DocumentMailAttachmentsTooLarge.
Benötigt einen Schlüssel mit der Berechtigung mail:send.
AuthentifizierungBearer <bm_…>Empfohlen: Authorization: Bearer bm_…. Der Schlüssel wird nur einmal angezeigt; nie in URLs, Logs oder Frontend-Code ablegen.
Idempotency-Key*stringStabiler Schlüssel für genau diese Änderung: 1–128 druckbare ASCII-Zeichen ohne Leerzeichen. Bei Wiederholungen denselben Schlüssel und unveränderten Inhalt senden; das Ergebnis wird nicht nochmals erzeugt.
^[!-~]+$1 <= length <= 128multipart/form-data- body
file*unknownGenau eine Datei: PDF, JPG oder PNG, höchstens 10 MiB.
Erfolg.
application/json- response
Eine Datei für Mails.
contentType?stringapplication/pdf, image/jpeg oder image/png.
filename?stringDateiname, die Endung passend zum erkannten Typ.
id?stringID der Datei, als uploadId in attachments.
uuidlength?integerGröße in Byte.
sha256?stringSHA-256 der Datei (Hex).
curl --fail-with-body "https://app.bimetrics.de/api/document-mail/attachments" \ -H "Authorization: Bearer $BIMETRICS_API_KEY" \ -H "Idempotency-Key: rechnung-2026-001" \ -F "auto[]=@rechnung.pdf"{ "contentType": "image/png", "filename": "Lageplan.png", "id": "7c2d4e6f-8a1b-4c3d-9e5f-0a1b2c3d4e5f", "length": 838912, "sha256": "4a7d4a7d4a7d4a7d4a7d4a7d4a7d4a7d4a7d4a7d4a7d4a7d4a7d4a7d4a7d4a7d"}Original zurückholen POST
Macht nach einem übernommenen Vorschlag das hochgeladene Original wieder zum Rechnungslogo. Ist es schon aktiv, ändert sich nichts. Benötigt einen Schlüssel mit der Berechtigung `layout:write`.
Mail vorbereiten POST
Liefert, was der Dialog „Per E-Mail senden“ der App vorschlägt: Empfänger aus dem Dokument oder seinem Kontakt, Betreff und Text aus der Vorlage der Firma mit den Werten des Dokuments, Signatur, Anhänge und die letzte Sendung. `html` zeigt die ganze Mail, wie sie versendet würde. Versendet wird nichts. Bei einem Entwurf antwortet die Route mit `409 DocumentMailNotIssued`. Benötigt einen Schlüssel mit der Berechtigung `sales:read` oder `read`.