Newsletter

App-Kennung: newsletter 9 Tools: 5 lesen, 2 anlegen, 1 ändern, 1 löschen Automatisch aus dem Code erzeugt

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

9 Tools

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.

Newsletter newsletter.newsletter.*

newsletter.newsletter.list Lesen Liste/Suche: Newsletter
Rechte
Newsletter lesen
Datenklassen
B (intern)
FeldTypPflichtBeschreibung
search string nein Freitextsuche
filters object nein Feld=Wert-Filter
limit integer nein
offset integer nein
orderBy string nein
Anfrage an POST /api/app-toolsIm Befehlsgenerator öffnen
{
  "name": "newsletter.newsletter.list",
  "input": {}
}
newsletter.newsletter.get Lesen Detail: Newsletter
Rechte
Newsletter lesen
Datenklassen
B (intern)
FeldTypPflichtBeschreibung
id string ja
Anfrage an POST /api/app-toolsIm Befehlsgenerator öffnen
{
  "name": "newsletter.newsletter.get",
  "input": {
    "id": "<id>"
  }
}
newsletter.newsletter.create Anlegen Bestätigung Anlegen: Newsletter
Rechte
Newsletter anlegen
Datenklassen
B (intern)
Bestätigung
Deine Anwendung zeigt die konkrete Aktion an und lässt sie ausdrücklich bestätigen, bevor sie das Tool ausführt.
FeldTypPflichtBeschreibung
name string ja
betreff string nein
status string nein
verteilerCode string nein
empfaengerCount number nein
versendetAm string nein
Anfrage an POST /api/app-toolsIm Befehlsgenerator öffnen
{
  "name": "newsletter.newsletter.create",
  "input": {
    "name": "<name>"
  }
}
newsletter.newsletter.update Ändern Bestätigung Ändern: Newsletter
Rechte
Newsletter ändern
Datenklassen
B (intern)
Bestätigung
Deine Anwendung zeigt die konkrete Aktion an und lässt sie ausdrücklich bestätigen, bevor sie das Tool ausführt.
FeldTypPflichtBeschreibung
id string ja ID des Datensatzes
name string nein
betreff string nein
status string nein
verteilerCode string nein
empfaengerCount number nein
versendetAm string nein
Anfrage an POST /api/app-toolsIm Befehlsgenerator öffnen
{
  "name": "newsletter.newsletter.update",
  "input": {
    "id": "<id>"
  }
}
newsletter.newsletter.delete Löschen Bestätigung Löschen: Newsletter
Rechte
Newsletter löschen
Datenklassen
B (intern)
Bestätigung
Deine Anwendung zeigt die konkrete Aktion an und lässt sie ausdrücklich bestätigen, bevor sie das Tool ausführt.
FeldTypPflichtBeschreibung
id string ja
Anfrage an POST /api/app-toolsIm Befehlsgenerator öffnen
{
  "name": "newsletter.newsletter.delete",
  "input": {
    "id": "<id>"
  }
}

Versand newsletter.versand.*

newsletter.versand.list Lesen Liste/Suche: Versand
Rechte
Versand lesen
Datenklassen
B (intern)
FeldTypPflichtBeschreibung
search string nein Freitextsuche
filters object nein Feld=Wert-Filter
limit integer nein
offset integer nein
orderBy string nein
Anfrage an POST /api/app-toolsIm Befehlsgenerator öffnen
{
  "name": "newsletter.versand.list",
  "input": {}
}
newsletter.versand.get Lesen Detail: Versand
Rechte
Versand lesen
Datenklassen
B (intern)
FeldTypPflichtBeschreibung
id string ja
Anfrage an POST /api/app-toolsIm Befehlsgenerator öffnen
{
  "name": "newsletter.versand.get",
  "input": {
    "id": "<id>"
  }
}

Weitere Aktionen

Eigene Aktionen der App, zum Beispiel Auswertungen, Versand, Zuordnungen oder Abläufe über mehrere Datensätze.

newsletter.preview Lesen Prueft Empfaenger-Segment und rendert die email-sichere HTML-Vorschau eines Newsletters (kein Versand)
Rechte
Newsletter lesenVersand lesen
Datenklassen
B (intern)
FeldTypPflichtBeschreibung
newsletterId string ja
Anfrage an POST /api/app-toolsIm Befehlsgenerator öffnen
{
  "name": "newsletter.preview",
  "input": {
    "newsletterId": "<newsletterId>"
  }
}
newsletter.send Anlegen Bestätigung Versendet einen Newsletter an das aufgeloeste Empfaenger-Segment (Gmail-Firmenpostfach/SMTP), je Mail mit …

Versendet einen Newsletter an das aufgeloeste Empfaenger-Segment (Gmail-Firmenpostfach/SMTP), je Mail mit Abmelde-Link. Nicht rueckholbar.

Rechte
Newsletter lesenNewsletter ändernVersand anlegen
Datenklassen
B (intern)
Bestätigung
Deine Anwendung zeigt die konkrete Aktion an und lässt sie ausdrücklich bestätigen, bevor sie das Tool ausführt.
Datenschutz
Versendet eine Massenmail an alle eingewilligten Empfaenger des Segments. Jede Mail traegt einen personalisierten Abmelde-Link.
FeldTypPflichtBeschreibung
newsletterId string ja
Anfrage an POST /api/app-toolsIm Befehlsgenerator öffnen
{
  "name": "newsletter.send",
  "input": {
    "newsletterId": "<newsletterId>"
  }
}

Als Klartext für KI-Assistenten: diese App, alle Apps und Artikel zur API in einer Datei: /api/llms.txt