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.
https://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"
}'import requests
reminder_id = 3187
response = requests.post(
"https://wbiztool.com/api/v1/reminder/cancel/",
json={
"client_id": 12345,
"api_key": "YOUR_API_KEY",
"reminder_id": str(reminder_id), # must be a string in JSON
},
timeout=60,
)
try:
result = response.json() # read the body even when the HTTP code is 400 or 404
except ValueError:
raise SystemExit(f"HTTP {response.status_code}: not JSON. Check that your api_key exists.")
if result["status"] == 1:
print("Reminder cancelled")
else:
print("Failed:", result["message"])// Node.js 18+ (built-in fetch). Save as .mjs to use top-level await.
const reminderId = 3187;
const response = await fetch("https://wbiztool.com/api/v1/reminder/cancel/", {
method: "POST",
headers: { "Content-Type": "application/json" },
body: JSON.stringify({
client_id: 12345,
api_key: "YOUR_API_KEY",
reminder_id: String(reminderId), // must be a string in JSON
}),
});
// Read the body even when the HTTP code is 400 or 404. A non-JSON reply means the request crashed.
const text = await response.text();
let result;
try {
result = JSON.parse(text);
} catch {
throw new Error(`HTTP ${response.status}: not JSON. Check your api_key and send reminder_id as a string.`);
}
if (result.status === 1) {
console.log("Reminder cancelled");
} else {
console.error("Failed:", result.message);
}<?php
$payload = [
'client_id' => 12345,
'api_key' => 'YOUR_API_KEY',
'reminder_id' => (string) 3187, // must be a string in JSON
];
$ch = curl_init('https://wbiztool.com/api/v1/reminder/cancel/');
curl_setopt_array($ch, [
CURLOPT_POST => true,
CURLOPT_HTTPHEADER => ['Content-Type: application/json'],
CURLOPT_POSTFIELDS => json_encode($payload),
CURLOPT_RETURNTRANSFER => true,
CURLOPT_TIMEOUT => 60,
]);
$result = json_decode(curl_exec($ch), true);
$httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
if ($result === null) {
echo "HTTP $httpCode: not JSON. Check your api_key and send reminder_id as a string.";
} elseif ($result['status'] === 1) {
echo 'Reminder cancelled';
} else {
echo 'Failed: ' . $result['message'];
}Ersetzen Sie 12345 und YOUR_API_KEY durch Ihre eigenen Werte. Wo Sie diese finden, steht unter Authentifizierung.
Request-Parameter#
client_idintegererforderlichIhre API-Client-ID aus Einstellungen → API-Schlüssel.
api_keystringerforderlichIhr API-Schlüssel von derselben Seite.
reminder_idstringerforderlichID 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.
Mit Formularfeldern umgehen Sie das Problem, weil jeder Formularwert ein String ist:
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
}
| Feld | Typ | Beschreibung |
|---|---|---|
status | integer | 1, wenn die Erinnerung storniert wurde, 0, wenn der Request fehlgeschlagen ist. |
message | string | Reminder 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" }
| Meldung | Lö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 null | Fügen Sie reminder_id hinzu. |
Auth Error - Please send correct API key and Client id | Senden Sie client_id und api_key. |
Invalid client id | Senden Sie client_id als Zahl. |
Invalid reminder id | reminder_id muss eine ganze Zahl sein, zum Beispiel 3187. |
Auth Error: invalid api key | Der Schlüssel gehört zu einer anderen client_id. |
Auth Error: please check client id | Der 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 APIs | Verwenden Sie ein reguläres Konto. |
Upgrade your plan to use reminders feature | Ihr Plan enthält keine Erinnerungen. Zuvor erstellte Erinnerungen laufen weiter und verbrauchen Credits, 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. |
Wenn der api_key nicht existiert oder gelöscht wurde, ist die Antwort eine HTML-Fehlerseite mit HTTP 500 statt JSON. Testen Sie Ihren Schlüssel mit Zugangsdaten prüfen.
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.
