API Pengingat
API Batalkan pengingat
Hentikan pengingat berulang agar tidak pernah dijalankan lagi. Gunakan saat pelanggan sudah membayar, langganan berakhir, atau otomatisasi tidak lagi diperlukan.
https://wbiztool.com/api/v1/reminder/cancel/Body: JSON atau field formulir
Anda memerlukan reminder_id yang dikembalikan oleh Buat pengingat. Jika Anda tidak memilikinya, temukan dengan Daftar pengingat.
Contoh singkat#
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": reminder_id,
},
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: reminderId,
}),
});
// 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.`);
}
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' => 3187,
];
$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.";
} elseif ($result['status'] === 1) {
echo 'Reminder cancelled';
} else {
echo 'Failed: ' . $result['message'];
}Ganti 12345 dan YOUR_API_KEY dengan nilai Anda sendiri. Lihat Autentikasi untuk mengetahui di mana menemukannya.
Parameter request#
AuthorizationheaderDisarankanBearer YOUR_API_KEY: kunci API Anda dari Pengaturan → Kunci API. Dengan header ini,client_iddanapi_keyboleh tidak dikirim di body; jika keduanya dikirim, kunci valid di header yang dipakai. Lihat Mengirim kunci di header.client_idintegerTanpa header AuthorizationAPI Client ID Anda dari Pengaturan → Kunci API. Opsional jika memakai header; jika Anda mengirimnya, nilainya harus Client ID workspace kunci tersebut.
api_keystringTanpa header AuthorizationKunci API Anda dari halaman yang sama, jika Anda tidak mengirimnya di header.
reminder_idstringwajibID pengingat yang akan dibatalkan, seperti yang dikembalikan oleh Buat pengingat atau Daftar pengingat. ID ini harus termasuk dalam workspace yang sama dengan kunci API.
Anda juga dapat mengirim field formulir sebagai pengganti JSON:
curl -X POST https://wbiztool.com/api/v1/reminder/cancel/ \
-d client_id=12345 \
-d api_key=YOUR_API_KEY \
-d reminder_id=3187
Respons#
Request yang berhasil mengembalikan HTTP 200:
{
"message": "Reminder cancelled successfully",
"status": 1
}
| Field | Tipe | Deskripsi |
|---|---|---|
status | integer | 1 jika pengingat dibatalkan, 0 jika request gagal. |
message | string | Reminder cancelled successfully, selain itu berisi error. |
Error#
Error mengembalikan HTTP 400 dengan status bernilai 0, kecuali disebutkan lain:
{ "status": 0, "message": "Reminder not found" }
| Pesan | Cara memperbaikinya |
|---|---|
Invalid JSON format: … | Body JSON tidak valid. Anda juga mendapatkan error ini untuk request formulir tanpa client_id, atau untuk request GET apa pun. |
Reminder ID cannot be null | Tambahkan reminder_id. |
Auth Error - Please send correct API key and Client id | Kirim client_id dan api_key. |
Invalid client id | Kirim client_id sebagai angka. |
Invalid reminder id | reminder_id harus berupa bilangan bulat, misalnya 3187. |
Auth Error: invalid api key | Kunci tersebut tidak ada, sudah dihapus, atau milik client_id lain. Uji kunci Anda dengan Cek kredensial. |
Auth Error: please check client id | Kunci tidak terhubung ke workspace. Buat kunci baru di workspace yang ingin Anda gunakan. |
Demo Account cannot access APIs | Gunakan akun biasa. |
Upgrade your plan to use reminders feature | Paket Anda tidak mencakup pengingat. Pengingat yang dibuat sebelumnya tetap berjalan dan mengirim pesan, dan tidak dapat dibatalkan atau dijeda, baik melalui API maupun dashboard, sampai Anda melakukan upgrade. |
Reminder not found (HTTP 404) | ID tidak ada, berada di workspace lain, atau pengingat sudah dibatalkan. |
Error cancelling reminder: … (HTTP 500) | Terjadi masalah di sisi kami. Coba lagi. |
Apa yang terjadi saat membatalkan#
- Pengingat langsung berhenti dan tidak akan dijalankan lagi. Pengingat yang sedang dijeda juga dapat dibatalkan.
- Pengingat hilang dari Daftar pengingat dan halaman Reminders (Pengingat).
- Pengingat yang dibatalkan tidak dapat dipulihkan. Untuk memulai lagi, buat pengingat baru.
- Pesan yang sudah dimasukkan ke antrean oleh pengingat sebelum Anda membatalkannya tidak dihapus dan mungkin tetap terkirim.
Tips#
- Membatalkan dua kali mengembalikan
Reminder not found. Jika Anda mencoba ulang request, anggap pesan tersebut berarti "sudah dibatalkan". - Menjeda tidak tersedia melalui API. Untuk menghentikan pengingat sementara, jeda di halaman Reminders.
- Mengubah jadwal: tidak ada API untuk memperbarui. Batalkan pengingat dan buat yang baru dengan
cron_expressionbaru.

