Hatırlatıcılar API'si
Hatırlatıcı iptal etme API'si
Tekrarlanan bir hatırlatıcıyı bir daha hiç çalışmayacak şekilde durdurun. Bir müşteri ödeme yaptığında, bir abonelik sona erdiğinde veya bir otomasyona artık gerek kalmadığında kullanın.
https://wbiztool.com/api/v1/reminder/cancel/Gövde: JSON veya form alanları
Hatırlatıcı oluşturma tarafından döndürülen reminder_id değerine ihtiyacınız vardır. Elinizde yoksa Hatırlatıcıları listeleme ile bulun.
Hızlı örnek#
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'];
}12345 ve YOUR_API_KEY değerlerini kendi değerlerinizle değiştirin. Bunları nerede bulacağınız için Kimlik doğrulama bölümüne bakın.
İstek parametreleri#
client_idintegerzorunluAyarlar → API anahtarları sayfasındaki API Client ID'niz.
api_keystringzorunluAynı sayfadaki API anahtarınız.
reminder_idstringzorunluİptal edilecek hatırlatıcının ID'si; Hatırlatıcı oluşturma veya Hatırlatıcıları listeleme tarafından döndürüldüğü şekilde. API anahtarıyla aynı çalışma alanına ait olmalıdır.
Form alanları göndermek bu sorunu önler, çünkü her form değeri bir string'dir:
curl -X POST https://wbiztool.com/api/v1/reminder/cancel/ \
-d client_id=12345 \
-d api_key=YOUR_API_KEY \
-d reminder_id=3187
Yanıt#
Başarılı bir istek HTTP 200 döndürür:
{
"message": "Reminder cancelled successfully",
"status": 1
}
| Alan | Tür | Açıklama |
|---|---|---|
status | integer | Hatırlatıcı iptal edildiyse 1, istek başarısız olduysa 0. |
message | string | Reminder cancelled successfully, aksi halde hata mesajı. |
Hatalar#
Aksi belirtilmedikçe hatalar, status değeri 0 olarak HTTP 400 döndürür:
{ "status": 0, "message": "Reminder not found" }
| Mesaj | Nasıl düzeltilir |
|---|---|
Invalid JSON format: … | JSON gövdesi geçerli değil. Bunu client_id olmayan bir form isteğinde veya herhangi bir GET isteğinde de alırsınız. |
Reminder ID cannot be null | reminder_id ekleyin. |
Auth Error - Please send correct API key and Client id | client_id ve api_key değerlerinin ikisini de gönderin. |
Invalid client id | client_id değerini sayı olarak gönderin. |
Invalid reminder id | reminder_id, 3187 gibi bir tam sayı olmalıdır. |
Auth Error: invalid api key | Anahtar farklı bir client_id değerine ait. |
Auth Error: please check client id | Anahtar bir çalışma alanına bağlı değil. Kullanmak istediğiniz çalışma alanında yeni bir anahtar oluşturun. |
Demo Account cannot access APIs | Normal bir hesap kullanın. |
Upgrade your plan to use reminders feature | Planınız hatırlatıcıları içermiyor. Daha önce oluşturulmuş hatırlatıcılar çalışmaya ve kredi harcamaya devam eder; planınızı yükseltene kadar API veya panel üzerinden iptal edilemez ya da duraklatılamazlar. |
Reminder not found (HTTP 404) | ID mevcut değil, başka bir çalışma alanında veya hatırlatıcı zaten iptal edilmiş. |
Error cancelling reminder: … (HTTP 500) | Bizim tarafımızda bir sorun oluştu. Tekrar deneyin. |
api_key mevcut değilse veya silinmişse, yanıt JSON yerine HTTP 500 ile bir HTML hata sayfasıdır. Anahtarınızı Kimlik bilgilerini kontrol etme ile test edin.
İptal etmek ne yapar#
- Hatırlatıcı hemen durur ve bir daha çalışmaz. Duraklatılmış hatırlatıcılar da iptal edilebilir.
- Hatırlatıcıları listeleme sonuçlarından ve Hatırlatıcılar sayfasından kaybolur.
- İptal edilen bir hatırlatıcı geri yüklenemez. Yeniden başlamak için yeni bir hatırlatıcı oluşturun.
- Hatırlatıcının siz iptal etmeden önce kuyruğa aldığı bir mesaj kaldırılmaz ve yine de gönderilebilir.
İpuçları#
- İki kez iptal etmek
Reminder not founddöndürür. İstekleri yeniden deniyorsanız bu mesajı „zaten iptal edildi" olarak değerlendirin. - Duraklatma API üzerinden yapılamaz. Bir hatırlatıcıyı geçici olarak durdurmak için bunun yerine Hatırlatıcılar sayfasında duraklatın.
- Zamanlamayı değiştirme: güncelleme API'si yoktur. Hatırlatıcıyı iptal edin ve yeni
cron_expressionile yeni bir hatırlatıcı oluşturun.
