# API-Referenz Newsletter (App-Kennung newsletter)

> 9 App-Tools. Aufruf immer mit `POST /api/app-tools`, Header `X-API-KEY`, Body `{"name": "<tool>", "input": {…}}`. Welche Tools ein Schlüssel nutzen darf, zeigt `GET /api/app-tools` der Instanz.

Quelle: https://support.unitedsynergy.com/api/referenz/newsletter/

## 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

Liste/Suche: Newsletter

- Art: Lesen
- Rechte: Newsletter lesen
- Datenklassen: B (intern)
- Eingabe:
  - `search` (string): Freitextsuche
  - `filters` (object): Feld=Wert-Filter
  - `limit` (integer)
  - `offset` (integer)
  - `orderBy` (string)
- Beispiel: `{"name":"newsletter.newsletter.list","input":{}}`

#### newsletter.newsletter.get

Detail: Newsletter

- Art: Lesen
- Rechte: Newsletter lesen
- Datenklassen: B (intern)
- Eingabe:
  - `id` (string, Pflicht)
- Beispiel: `{"name":"newsletter.newsletter.get","input":{"id":"<id>"}}`

#### newsletter.newsletter.create

Anlegen: Newsletter

- Art: Anlegen, vor dem Ausführen ausdrücklich bestätigen lassen
- Rechte: Newsletter anlegen
- Datenklassen: B (intern)
- Eingabe:
  - `name` (string, Pflicht)
  - `betreff` (string)
  - `status` (string)
  - `verteilerCode` (string)
  - `empfaengerCount` (number)
  - `versendetAm` (string)
- Beispiel: `{"name":"newsletter.newsletter.create","input":{"name":"<name>"}}`

#### newsletter.newsletter.update

Ändern: Newsletter

- Art: Ändern, vor dem Ausführen ausdrücklich bestätigen lassen
- Rechte: Newsletter ändern
- Datenklassen: B (intern)
- Eingabe:
  - `id` (string, Pflicht): ID des Datensatzes
  - `name` (string)
  - `betreff` (string)
  - `status` (string)
  - `verteilerCode` (string)
  - `empfaengerCount` (number)
  - `versendetAm` (string)
- Beispiel: `{"name":"newsletter.newsletter.update","input":{"id":"<id>"}}`

#### newsletter.newsletter.delete

Löschen: Newsletter

- Art: Löschen, vor dem Ausführen ausdrücklich bestätigen lassen
- Rechte: Newsletter löschen
- Datenklassen: B (intern)
- Eingabe:
  - `id` (string, Pflicht)
- Beispiel: `{"name":"newsletter.newsletter.delete","input":{"id":"<id>"}}`

### Versand: `newsletter.versand.*`

#### newsletter.versand.list

Liste/Suche: Versand

- Art: Lesen
- Rechte: Versand lesen
- Datenklassen: B (intern)
- Eingabe:
  - `search` (string): Freitextsuche
  - `filters` (object): Feld=Wert-Filter
  - `limit` (integer)
  - `offset` (integer)
  - `orderBy` (string)
- Beispiel: `{"name":"newsletter.versand.list","input":{}}`

#### newsletter.versand.get

Detail: Versand

- Art: Lesen
- Rechte: Versand lesen
- Datenklassen: B (intern)
- Eingabe:
  - `id` (string, Pflicht)
- Beispiel: `{"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

Prueft Empfaenger-Segment und rendert die email-sichere HTML-Vorschau eines Newsletters (kein Versand)

- Art: Lesen
- Rechte: Newsletter lesen, Versand lesen
- Datenklassen: B (intern)
- Eingabe:
  - `newsletterId` (string, Pflicht)
- Beispiel: `{"name":"newsletter.preview","input":{"newsletterId":"<newsletterId>"}}`

#### newsletter.send

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

- Art: Anlegen, vor dem Ausführen ausdrücklich bestätigen lassen
- Rechte: Newsletter lesen, Newsletter ändern, Versand anlegen
- Datenklassen: B (intern)
- Datenschutz: Versendet eine Massenmail an alle eingewilligten Empfaenger des Segments. Jede Mail traegt einen personalisierten Abmelde-Link.
- Eingabe:
  - `newsletterId` (string, Pflicht)
- Beispiel: `{"name":"newsletter.send","input":{"newsletterId":"<newsletterId>"}}`