Zum Inhalt springen
WbizTool

Erinnerungs-API

Erinnerung stornieren (API)

Stoppen Sie eine wiederkehrende Erinnerung, damit sie nie wieder ausgeführt wird. Nutzen Sie die API, wenn ein Kunde bezahlt, ein Abonnement endet oder eine Automatisierung nicht mehr benötigt wird.

POSThttps://wbiztool.com/api/v1/reminder/cancel/

Body: JSON oder Formularfelder

Sie benötigen die von Erinnerung erstellen zurückgegebene reminder_id. Falls Sie sie nicht haben, finden Sie sie mit Erinnerungen auflisten.

Kurzes Beispiel#

curl -X POST https://wbiztool.com/api/v1/reminder/cancel/ \
  -H "Content-Type: application/json" \
  -d '{
    "client_id": 12345,
    "api_key": "YOUR_API_KEY",
    "reminder_id": "3187"
  }'

Ersetzen Sie 12345 und YOUR_API_KEY durch Ihre eigenen Werte. Wo Sie diese finden, steht unter Authentifizierung.

Request-Parameter#

client_idintegererforderlich

Ihre API-Client-ID aus Einstellungen → API-Schlüssel.

api_keystringerforderlich

Ihr API-Schlüssel von derselben Seite.

reminder_idstringerforderlich

ID der zu stornierenden Erinnerung, wie von Erinnerung erstellen oder Erinnerungen auflisten zurückgegeben. Sie muss zum selben Arbeitsbereich wie der API-Schlüssel gehören.

Sie können statt JSON auch Formularfelder senden:

curl -X POST https://wbiztool.com/api/v1/reminder/cancel/ \
  -d client_id=12345 \
  -d api_key=YOUR_API_KEY \
  -d reminder_id=3187

Antwort#

Ein erfolgreicher Request gibt HTTP 200 zurück:

{
  "message": "Reminder cancelled successfully",
  "status": 1
}
FeldTypBeschreibung
statusinteger1, wenn die Erinnerung storniert wurde, 0, wenn der Request fehlgeschlagen ist.
messagestringReminder cancelled successfully, andernfalls der Fehler.

Fehler#

Fehler geben HTTP 400 mit status gleich 0 zurück, sofern nicht anders angegeben:

{ "status": 0, "message": "Reminder not found" }
MeldungLösung
Invalid JSON format: …Der JSON-Body ist ungültig. Diese Meldung erhalten Sie auch bei einem Formular-Request ohne client_id oder bei jedem GET-Request.
Reminder ID cannot be nullFügen Sie reminder_id hinzu.
Auth Error - Please send correct API key and Client idSenden Sie client_id und api_key.
Invalid client idSenden Sie client_id als Zahl.
Invalid reminder idreminder_id muss eine ganze Zahl sein, zum Beispiel 3187.
Auth Error: invalid api keyDer Schlüssel existiert nicht, wurde gelöscht oder gehört zu einer anderen client_id. Testen Sie ihn mit Zugangsdaten prüfen.
Auth Error: please check client idDer Schlüssel ist mit keinem Arbeitsbereich verknüpft. Erstellen Sie einen neuen Schlüssel in dem Arbeitsbereich, den Sie verwenden möchten.
Demo Account cannot access APIsVerwenden Sie ein reguläres Konto.
Upgrade your plan to use reminders featureIhr Plan enthält keine Erinnerungen. Zuvor erstellte Erinnerungen laufen weiter und senden Nachrichten, und sie können bis zu einem Upgrade weder über die API noch im Dashboard storniert oder pausiert werden.
Reminder not found (HTTP 404)Die ID existiert nicht, gehört zu einem anderen Arbeitsbereich, oder die Erinnerung wurde bereits storniert.
Error cancelling reminder: … (HTTP 500)Auf unserer Seite ist etwas schiefgelaufen. Versuchen Sie es erneut.

Was das Stornieren bewirkt#

  • Die Erinnerung stoppt sofort und wird nicht mehr ausgeführt. Auch pausierte Erinnerungen können storniert werden.
  • Sie verschwindet aus Erinnerungen auflisten und von der Seite Erinnerungen.
  • Eine stornierte Erinnerung kann nicht wiederhergestellt werden. Um neu zu beginnen, erstellen Sie eine neue Erinnerung.
  • Eine Nachricht, die die Erinnerung vor dem Stornieren bereits in die Warteschlange gestellt hat, wird nicht entfernt und kann trotzdem gesendet werden.

Tipps#

  • Zweimaliges Stornieren liefert Reminder not found. Wenn Sie Requests wiederholen, behandeln Sie diese Meldung als „bereits storniert“.
  • Pausieren ist über die API nicht möglich. Um eine Erinnerung vorübergehend zu stoppen, pausieren Sie sie stattdessen auf der Seite Erinnerungen.
  • Zeitplan ändern: Es gibt keine API zum Aktualisieren. Stornieren Sie die Erinnerung und erstellen Sie eine neue mit dem neuen cron_expression.