Vorlagen
Jedes Tool rufst du mit POST /api/app-tools und dem Tool-Namen auf. Klapp ein Tool auf, um Eingabefelder, nötige Rechte und eine Beispiel-Anfrage zu sehen. Ob dein API-Key ein Tool nutzen darf, zeigt der Katalog deiner Instanz (App-Tools-API).
Wie die App in der Oberfläche funktioniert, steht in der Hilfe unter Vorlagen.
Kein Tool passt zu deiner Eingabe.
Datenobjekte
Die Standard-Aktionen je Datenobjekt: list (suchen und blättern), get (einen Datensatz lesen), create, update und delete. Nicht jedes Objekt bietet alle fünf an.
Datenobjekte (Template-Entitäten) textbausteine.datenobjekt.*
textbausteine.datenobjekt.list Lesen Liste/Suche: Datenobjekte (Template-Entitäten)
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
search | string | nein | Freitextsuche |
filters | object | nein | Feld=Wert-Filter |
limit | integer | nein | |
offset | integer | nein | |
orderBy | string | nein |
{
"name": "textbausteine.datenobjekt.list",
"input": {}
} textbausteine.datenobjekt.get Lesen Detail: Datenobjekte (Template-Entitäten)
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
id | string | ja |
{
"name": "textbausteine.datenobjekt.get",
"input": {
"id": "<id>"
}
} textbausteine.datenobjekt.update Ändern Bestätigung Ändern: Datenobjekte (Template-Entitäten)
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
id | string | ja | ID des Datensatzes |
name | string | nein | |
isActive | boolean | nein |
{
"name": "textbausteine.datenobjekt.update",
"input": {
"id": "<id>"
}
} Dokument-/Mail-Vorlagen textbausteine.vorlage.*
textbausteine.vorlage.list Lesen Liste/Suche: Dokument-/Mail-Vorlagen
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
search | string | nein | Freitextsuche |
filters | object | nein | Feld=Wert-Filter |
limit | integer | nein | |
offset | integer | nein | |
orderBy | string | nein |
{
"name": "textbausteine.vorlage.list",
"input": {}
} textbausteine.vorlage.get Lesen Detail: Dokument-/Mail-Vorlagen
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
id | string | ja |
{
"name": "textbausteine.vorlage.get",
"input": {
"id": "<id>"
}
} textbausteine.vorlage.create Anlegen Bestätigung Anlegen: Dokument-/Mail-Vorlagen
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
name | string | ja | |
format | string | nein | PDF/WORD/EXCEL/PPTX/EMAIL Werte: PDF, WORD, EXCEL, PPTX, EMAIL |
category | string | nein | |
app | string | nein | |
entityTypeId | string | nein | |
layoutId | string | nein | |
orientation | string | nein | Werte: portrait, landscape |
header | string | nein | |
footer | string | nein | |
mailMode | string | nein | marketing = visueller Block-Builder Werte: einfach, marketing |
subject | string | nein | |
body | string | nein | |
senderAccountId | string | nein |
{
"name": "textbausteine.vorlage.create",
"input": {
"name": "<name>"
}
} textbausteine.vorlage.update Ändern Bestätigung Ändern: Dokument-/Mail-Vorlagen
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
id | string | ja | ID des Datensatzes |
name | string | nein | |
format | string | nein | PDF/WORD/EXCEL/PPTX/EMAIL Werte: PDF, WORD, EXCEL, PPTX, EMAIL |
category | string | nein | |
app | string | nein | |
entityTypeId | string | nein | |
layoutId | string | nein | |
orientation | string | nein | Werte: portrait, landscape |
header | string | nein | |
footer | string | nein | |
mailMode | string | nein | marketing = visueller Block-Builder Werte: einfach, marketing |
subject | string | nein | |
body | string | nein | |
senderAccountId | string | nein |
{
"name": "textbausteine.vorlage.update",
"input": {
"id": "<id>"
}
} textbausteine.vorlage.delete Löschen Bestätigung Löschen: Dokument-/Mail-Vorlagen
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
id | string | ja |
{
"name": "textbausteine.vorlage.delete",
"input": {
"id": "<id>"
}
} Dokument-Layouts textbausteine.layout.*
textbausteine.layout.list Lesen Liste/Suche: Dokument-Layouts
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
search | string | nein | Freitextsuche |
filters | object | nein | Feld=Wert-Filter |
limit | integer | nein | |
offset | integer | nein | |
orderBy | string | nein |
{
"name": "textbausteine.layout.list",
"input": {}
} textbausteine.layout.get Lesen Detail: Dokument-Layouts
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
id | string | ja |
{
"name": "textbausteine.layout.get",
"input": {
"id": "<id>"
}
} textbausteine.layout.create Anlegen Bestätigung Anlegen: Dokument-Layouts
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
bezeichnung | string | ja | |
kategorie | string | nein | |
header | string | nein | |
fusszeile | string | nein |
{
"name": "textbausteine.layout.create",
"input": {
"bezeichnung": "<bezeichnung>"
}
} textbausteine.layout.update Ändern Bestätigung Ändern: Dokument-Layouts
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
id | string | ja | ID des Datensatzes |
bezeichnung | string | nein | |
kategorie | string | nein | |
header | string | nein | |
fusszeile | string | nein |
{
"name": "textbausteine.layout.update",
"input": {
"id": "<id>"
}
} textbausteine.layout.delete Löschen Bestätigung Löschen: Dokument-Layouts
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
id | string | ja |
{
"name": "textbausteine.layout.delete",
"input": {
"id": "<id>"
}
} Wertelisten
Auswahllisten der App wie Status, Arten oder Kategorien. Du pflegst sie mit denselben fünf Aktionen. Die Werte (code) nutzt du in den Feldern der Datenobjekte.
Dokument-Typen textbausteine.dokument_typ.* list · get · create · update · delete
textbausteine.dokument_typ.list Lesen Liste/Suche: Katalog „Dokument-Typen" (textbausteine)
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
onlyAktiv | boolean | nein | Nur aktive Einträge |
{
"name": "textbausteine.dokument_typ.list",
"input": {}
} textbausteine.dokument_typ.get Lesen Detail: Katalog „Dokument-Typen" (textbausteine)
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
id | string | ja |
{
"name": "textbausteine.dokument_typ.get",
"input": {
"id": "<id>"
}
} textbausteine.dokument_typ.create Anlegen Bestätigung Anlegen: Katalog „Dokument-Typen" (textbausteine)
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
label | string | ja | Anzeige-Text |
code | string | nein | Optional, sonst aus label abgeleitet. Immutable. |
color | string | nein | Tailwind-Paar, z.B. "bg-blue-100 text-blue-700" |
icon | string | nein | Lucide-Icon-Name |
beschreibung | string | nein |
{
"name": "textbausteine.dokument_typ.create",
"input": {
"label": "<label>"
}
} textbausteine.dokument_typ.update Ändern Bestätigung Ändern: Katalog „Dokument-Typen" (textbausteine)
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
id | string | ja | |
label | string | nein | |
color | string | nein | |
icon | string | nein | |
beschreibung | string | nein | |
aktiv | boolean | nein |
{
"name": "textbausteine.dokument_typ.update",
"input": {
"id": "<id>"
}
} textbausteine.dokument_typ.delete Löschen Bestätigung Löschen: Katalog „Dokument-Typen" (textbausteine)
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
id | string | ja |
{
"name": "textbausteine.dokument_typ.delete",
"input": {
"id": "<id>"
}
} Vorlagen-Kategorien textbausteine.vorlage_kategorie.* list · get · create · update · delete
textbausteine.vorlage_kategorie.list Lesen Liste/Suche: Katalog „Vorlagen-Kategorien" (textbausteine)
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
onlyAktiv | boolean | nein | Nur aktive Einträge |
{
"name": "textbausteine.vorlage_kategorie.list",
"input": {}
} textbausteine.vorlage_kategorie.get Lesen Detail: Katalog „Vorlagen-Kategorien" (textbausteine)
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
id | string | ja |
{
"name": "textbausteine.vorlage_kategorie.get",
"input": {
"id": "<id>"
}
} textbausteine.vorlage_kategorie.create Anlegen Bestätigung Anlegen: Katalog „Vorlagen-Kategorien" (textbausteine)
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
label | string | ja | Anzeige-Text |
code | string | nein | Optional, sonst aus label abgeleitet. Immutable. |
color | string | nein | Tailwind-Paar, z.B. "bg-blue-100 text-blue-700" |
icon | string | nein | Lucide-Icon-Name |
beschreibung | string | nein |
{
"name": "textbausteine.vorlage_kategorie.create",
"input": {
"label": "<label>"
}
} textbausteine.vorlage_kategorie.update Ändern Bestätigung Ändern: Katalog „Vorlagen-Kategorien" (textbausteine)
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
id | string | ja | |
label | string | nein | |
color | string | nein | |
icon | string | nein | |
beschreibung | string | nein | |
aktiv | boolean | nein |
{
"name": "textbausteine.vorlage_kategorie.update",
"input": {
"id": "<id>"
}
} textbausteine.vorlage_kategorie.delete Löschen Bestätigung Löschen: Katalog „Vorlagen-Kategorien" (textbausteine)
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
id | string | ja |
{
"name": "textbausteine.vorlage_kategorie.delete",
"input": {
"id": "<id>"
}
} Weitere Aktionen
Eigene Aktionen der App, zum Beispiel Auswertungen, Versand, Zuordnungen oder Abläufe über mehrere Datensätze.
textbausteine.create_document_record Anlegen Bestätigung Legt einen Eintrag in der Versand-Dokumentbibliothek an
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
titel | string | ja | |
typCode | string | nein | |
category | string | nein | |
mailbar | boolean | nein | |
beschreibung | string | nein |
{
"name": "textbausteine.create_document_record",
"input": {
"titel": "<titel>"
}
} textbausteine.create_layout Anlegen Bestätigung Legt ein Dokument-Layout fuer Vorlagen an
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
name | string | ja | |
category | string | nein | |
header | string | nein | |
footer | string | nein |
{
"name": "textbausteine.create_layout",
"input": {
"name": "<name>"
}
} textbausteine.create_sequenz Anlegen Bestätigung Legt eine Mail-Sequenz an (optional mit Schritten: Betreff/Text/Vorlage + Versatz in Tagen)
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
name | string | ja | |
steps | object[] | nein |
{
"name": "textbausteine.create_sequenz",
"input": {
"name": "<name>"
}
} textbausteine.create_template Anlegen Bestätigung Legt Dokument-, Word-, Excel-, PPTX- oder Mail-Vorlagen fuer Chat/API/MCP an
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
name | string | ja | |
format | string | nein | Werte: PDF, WORD, EXCEL, PPTX, EMAIL |
category | string | nein | |
app | string | nein | |
entityTypeId | string | nein | |
layoutId | string | nein | |
orientation | string | nein | Werte: portrait, landscape |
content | string | nein | |
body | string | nein | |
subject | string | nein | |
mailMode | string | nein | Werte: einfach, marketing |
mailBg | string | nein | |
mailWidth | integer | nein | |
reportId | string | nein | |
dataSource | string | nein | Kurzform: listPath fuer eine einzelne Positionstabelle (statt elements). z.B. "positionen". |
columns | object[] | nein | Spalten der Kurzform-Positionstabelle (nur mit dataSource). Pro Spalte field ODER template. |
elements | object[] | nein | Voller Block-Baum (Vorrang vor content/dataSource). Block-Typen: RICH_TEXT {content:"<p>..${var}..</p>"} · DYNAMIC_TABLE {config:{dataSource:"<listPath>",showHeaders,borderStyle,headerBgColor,cellPadding,fontSize,columns:[{field|template,label,width,alignment,format}]}} · REPEATER {config:{dataSource},children:[...]} · LAYOUT_ROW{children:[{type:"LAYOUT_COLUMN",width,children:[...]}]} · PAGE_BREAK. |
mailBlocks | object[] | nein | |
attachmentTemplateIds | string[] | nein |
{
"name": "textbausteine.create_template",
"input": {
"name": "<name>"
}
} textbausteine.enroll_in_sequenz Anlegen Bestätigung Schreibt einen Empfänger (E-Mail, optional CRM-Kontakt/Konto) in eine Sequenz ein; startet ab heute oder …
Schreibt einen Empfänger (E-Mail, optional CRM-Kontakt/Konto) in eine Sequenz ein; startet ab heute oder startAt
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
sequenzId | string | ja | |
email | string | ja | |
kontaktId | string | nein | |
kontoId | string | nein | |
startAt | string | nein | ISO-Datum, ab dem Schritt 1 fällig wird (sonst sofort) |
{
"name": "textbausteine.enroll_in_sequenz",
"input": {
"sequenzId": "<sequenzId>",
"email": "<email>"
}
} textbausteine.generate_document Export Bestätigung Erzeugt aus einer Vorlage ein PDF, DOCX oder XLSX und legt die Datei im Files-Service ab
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
templateId | string | ja | |
format | string | nein | Werte: pdf, docx, xlsx |
data | object | nein | |
variables | object | nein | |
filename | string | nein | |
ownerType | string | nein | |
ownerId | string | nein |
{
"name": "textbausteine.generate_document",
"input": {
"templateId": "<templateId>"
}
} textbausteine.list_documents Lesen Listet kuratierte Versand-Dokumente aus der Dokumentenbibliothek
Keine Eingabe nötig, sende ein leeres Objekt als input.
{
"name": "textbausteine.list_documents",
"input": {}
} textbausteine.list_enrollments Lesen Listet Sequenz-Läufe, entweder einer Sequenz (sequenzId) oder eines CRM-Kontos (kontoId), inkl.
Listet Sequenz-Läufe, entweder einer Sequenz (sequenzId) oder eines CRM-Kontos (kontoId), inkl. Fortschritt
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
sequenzId | string | nein | |
kontoId | string | nein |
{
"name": "textbausteine.list_enrollments",
"input": {}
} textbausteine.list_entities Lesen Listet Datenobjekte fuer Vorlagen- und Excel-Erzeugung
Keine Eingabe nötig, sende ein leeres Objekt als input.
{
"name": "textbausteine.list_entities",
"input": {}
} textbausteine.list_layouts Lesen Listet Dokument-Layouts fuer Vorlagen
Keine Eingabe nötig, sende ein leeres Objekt als input.
{
"name": "textbausteine.list_layouts",
"input": {}
} textbausteine.list_sequenzen Lesen Listet Mail-Sequenzen (Cadences) des Tenants mit Schritt- und Lauf-Anzahl
Keine Eingabe nötig, sende ein leeres Objekt als input.
{
"name": "textbausteine.list_sequenzen",
"input": {}
} textbausteine.list_templates Lesen Listet Dokument-, Excel- und Mail-Vorlagen des aktiven Tenants
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
typ | string | nein | Werte: PDF, WORD, EXCEL, PPTX, EMAIL |
limit | integer | nein |
{
"name": "textbausteine.list_templates",
"input": {}
} textbausteine.send_mail_template Anlegen Bestätigung Versendet eine bestehende Textbaustein-Mailvorlage ueber den vorhandenen Tenant-Mail-Service
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
templateId | string | ja | |
to | string | ja | |
toName | string | nein | |
data | object | nein | |
variables | object | nein |
{
"name": "textbausteine.send_mail_template",
"input": {
"templateId": "<templateId>",
"to": "<to>"
}
} textbausteine.send_template_for_record Anlegen Bestätigung Robust: Mail-Vorlage mit echten Daten senden.
Robust: Mail-Vorlage mit echten Daten senden. Baut einen namespaced Multi-Entität-Kontext aus den mitgegebenen Records: ${konto.*} (kontoId), ${kontakt.*} (kontaktId), ${angebot.*} (belegId), ${absender.*} (absenderName/-Email, frei wählbar). Gate: bleibt ein ${…} unaufgelöst → KEIN Versand (Liste der fehlenden Felder). dryRun=true (Default) = Vorschau. Empfänger aus kontakt.email oder to. Absender: verbundenes Gmail-Konto (absenderEmail) → von dort, sonst Tenant-Default. Für Angebote mit PDF: /angebot (belege.versende).
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
templateId | string | ja | |
kontoId | string | nein | CRM-Konto → ${konto.*} |
kontaktId | string | nein | Ansprechpartner → ${kontakt.*} (auch Default-Empfänger via kontakt.email) |
belegId | string | nein | Beleg/Angebot → ${angebot.*} |
belegPdf | boolean | nein | true = Angebot-PDF aus dem Beleg (belegId) rendern + anhängen (für /angebot). Braucht ein Gmail-Konto (absenderEmail). |
absenderName | string | nein | Absender-Name → ${absender.name} (frei wählbar) |
absenderEmail | string | nein | Absender-Email → ${absender.email}; ist es ein verbundenes Gmail-Konto, wird VON dort gesendet. |
to | string | nein | Empfänger-Override; sonst kontakt.email. |
toName | string | nein | |
dryRun | boolean | nein | Default true (Vorschau + Platzhalter-Check). false = echter Versand. |
{
"name": "textbausteine.send_template_for_record",
"input": {
"templateId": "<templateId>"
}
} textbausteine.set_enrollment_status Ändern Bestätigung Setzt den Status eines Sequenz-Laufs: pausiert | aktiv (fortsetzen) | gestoppt
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
enrollmentId | string | ja | |
status | string | ja | Werte: aktiv, pausiert, gestoppt |
grund | string | nein |
{
"name": "textbausteine.set_enrollment_status",
"input": {
"enrollmentId": "<enrollmentId>",
"status": "aktiv"
}
} textbausteine.update_document_record Ändern Bestätigung Aktualisiert einen Eintrag in der Versand-Dokumentbibliothek
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
documentId | string | ja | |
titel | string | nein | |
typCode | string | nein | |
category | string | nein | |
mailbar | boolean | nein | |
beschreibung | string | nein |
{
"name": "textbausteine.update_document_record",
"input": {
"documentId": "<documentId>"
}
} textbausteine.update_layout Ändern Bestätigung Aktualisiert ein Dokument-Layout
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
layoutId | string | ja | |
name | string | ja | |
category | string | nein | |
header | string | nein | |
footer | string | nein |
{
"name": "textbausteine.update_layout",
"input": {
"layoutId": "<layoutId>",
"name": "<name>"
}
} textbausteine.update_template Ändern Bestätigung Aktualisiert eine bestehende Vorlage, inklusive Mail-, Marketing-, Dokument- und Excel-Inhalt
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
templateId | string | ja | |
name | string | nein | |
format | string | nein | Werte: PDF, WORD, EXCEL, PPTX, EMAIL |
category | string | nein | |
app | string | nein | |
entityTypeId | string | nein | |
layoutId | string | nein | |
orientation | string | nein | Werte: portrait, landscape |
content | string | nein | |
body | string | nein | |
subject | string | nein | |
mailMode | string | nein | Werte: einfach, marketing |
mailBg | string | nein | |
mailWidth | integer | nein | |
reportId | string | nein | |
dataSource | string | nein | Kurzform: listPath fuer eine einzelne Positionstabelle (statt elements). z.B. "positionen". |
columns | object[] | nein | Spalten der Kurzform-Positionstabelle (nur mit dataSource). Pro Spalte field ODER template. |
elements | object[] | nein | Voller Block-Baum (Vorrang vor content/dataSource). Block-Typen: RICH_TEXT {content:"<p>..${var}..</p>"} · DYNAMIC_TABLE {config:{dataSource:"<listPath>",showHeaders,borderStyle,headerBgColor,cellPadding,fontSize,columns:[{field|template,label,width,alignment,format}]}} · REPEATER {config:{dataSource},children:[...]} · LAYOUT_ROW{children:[{type:"LAYOUT_COLUMN",width,children:[...]}]} · PAGE_BREAK. |
mailBlocks | object[] | nein | |
attachmentTemplateIds | string[] | nein |
{
"name": "textbausteine.update_template",
"input": {
"templateId": "<templateId>"
}
} textbausteine.upsert_entity Ändern Bestätigung Legt ein Datenobjekt (Entity) an oder aktualisiert es, inkl.
Legt ein Datenobjekt (Entity) an oder aktualisiert es, inkl. Datenquellen (Tabelle+Alias+Felder), Joins, Filter, Parameter. NICHT fuer Belege/CRM-Personendaten verwenden (Datenschutz: Belege binden direkt an den Beleg-Kontext, ohne Datenobjekt).
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
id | string | nein | Vorhandene Entity-ID zum Aktualisieren; weglassen = neu anlegen. |
name | string | ja | |
isActive | boolean | nein | |
dataSources | object[] | ja | Datenquellen. Erste = Basistabelle. |
joins | object[] | nein | |
filters | object[] | nein | |
parameters | object[] | nein |
{
"name": "textbausteine.upsert_entity",
"input": {
"name": "<name>",
"dataSources": []
}
} Als Klartext für KI-Assistenten: diese App, alle Apps und Artikel zur API in einer Datei: /api/llms.txt