Benachrichtigungen und E-Mail-Vorlagen

Was du tun kannst

Mit diesen Endpunkten steuerst du die E-Mail-Seite eines einzelnen Flipbooks: welche Ereignisse dich benachrichtigen und was diese E-Mails sagen. Damit kannst du:

• Konfigurieren, welche Benachrichtigungen du erhältst für ein Flipbook (neuer Lead, neuer View, neuer Sale).
• Die Neu-Lead-E-Mail anpassen – Betreff und Text, die bei einem Neu-Lead-Ereignis gesendet werden.
• Die Neu-View-E-Mail anpassen – Betreff und Text, die bei einer Neu-View-Benachrichtigung gesendet werden.
• Die Neu-Sale-E-Mail anpassen – Betreff und Text, die bei einer Neu-Sale-Benachrichtigung gesendet werden.
• Jede Vorlage auf ihren Standard zurücksetzen, indem du leere Werte sendest.

Bevor du loslegst

• Einen API-Schlüssel – wird bei jeder Anfrage entweder als X-Api-Key-Header oder als Authorization: Bearer YOUR_API_KEY gesendet.
• Die {flipbookId} – die numerische ID des Flipbooks/Dokuments. Sie wird von create-by-file / create-by-url (als ID) oder von list zurückgegeben. Jeder Endpunkt hier nimmt sie als Pfadparameter entgegen.
• Alle Anfragen gehen an die Basis-URL https://go.fliplink.me.

Jeder Request-Body ist form-urlencoded (kein JSON) – sende die Felder mit --data-urlencode.

Benachrichtigungen konfigurieren

Verwende PUT /api/set-notifications/{flipbookId}, um zu konfigurieren, welche E-Mail-Benachrichtigungen du für dieses Flipbook erhältst (neuer Lead, neuer View, neuer Sale).

Body-Felder (form-urlencoded):

• NotificationsEmail – die Zieladresse, an die Benachrichtigungs-E-Mails gesendet werden. Bei einem neuen Flipbook ist sie standardmäßig deine Konto-E-Mail; du kannst sie in eine beliebige Adresse ändern oder leer senden, um sie zu löschen.
• IsSendEmailOnView – ein boolean (true / false, Standard false), der die „viewed“-E-Mail umschaltet. Setze ihn true, um eine E-Mail zu erhalten, wenn jemand das Flipbook ansieht. Das Beispiel unten sendet true.

curl -X PUT 'https://go.fliplink.me/api/set-notifications/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'NotificationsEmail=you@example.com' \
  --data-urlencode 'IsSendEmailOnView=true'

Antwort:

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Die Neu-Lead-E-Mail-Vorlage festlegen

Verwende PUT /api/set-email-template-lead/{flipbookId}, um die E-Mail festzulegen, die bei einem Neu-Lead-Ereignis gesendet wird. Sende leere Werte, um die Standardvorlage NEW_LEAD wiederherzustellen.

curl -X PUT 'https://go.fliplink.me/api/set-email-template-lead/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'EmailLeadSubject=' \
  --data-urlencode 'EmailLeadBody='

Antwort:

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Die Neu-View-E-Mail-Vorlage festlegen

Verwende PUT /api/set-email-template-view/{flipbookId}, um die E-Mail-Vorlage festzulegen, die bei einer Neu-View-Benachrichtigung gesendet wird. Sende leer, um die Standardvorlage NEW_VIEW wiederherzustellen.

curl -X PUT 'https://go.fliplink.me/api/set-email-template-view/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'EmailViewSubject=' \
  --data-urlencode 'EmailViewBody='

Antwort:

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Die Neu-Sale-E-Mail-Vorlage festlegen

Verwende PUT /api/set-email-template-sale/{flipbookId}, um die E-Mail-Vorlage festzulegen, die bei einer Neu-Sale-Benachrichtigung gesendet wird. Sende leer, um die Standardvorlage NEW_SALE wiederherzustellen.

curl -X PUT 'https://go.fliplink.me/api/set-email-template-sale/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'EmailSaleSubject=' \
  --data-urlencode 'EmailSaleBody='

Antwort:

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Mögliche Fehler

• Fehlender oder ungültiger API-Schlüssel → HTTP 401. Das gibt eine reine Unauthorized-HTML-Seite zurück – es gibt keinen JSON-Body. Prüfe, ob der X-Api-Key-Header (oder das Authorization: Bearer-Token) vorhanden und korrekt ist.
• Item-ID nicht gefunden oder nicht im Besitz deines Schlüssels → HTTP 200 mit Message: "Item not found".
• Unbekanntes oder falsch geschriebenes Body-Feld → HTTP 200 mit Message: "Unknown field(s) '…'. Expected: …".

Hinweise

• Die Lead-, View- und Sale-E-Mail-Vorlagen kommen jeweils mit eingebautem Standardtext. Wenn du leere Werte sendest, wird die Standardvorlage dieses Ereignisses wiederhergestellt (NEW_LEAD, NEW_VIEW bzw. NEW_SALE).
• Merge-Tokens verwenden die ##TOKEN##-Konvention – zum Beispiel fügt ##FLIPLINK## den Flipbook-Namen in den Betreff oder Text ein.