API des rappels
API d'annulation de rappels
Arrêtez un rappel récurrent pour qu'il ne s'exécute plus jamais. Utilisez-la lorsqu'un client paie, qu'un abonnement se termine ou qu'une automatisation n'est plus nécessaire.
https://wbiztool.com/api/v1/reminder/cancel/Corps: JSON ou champs de formulaire
Vous avez besoin du reminder_id renvoyé par Créer un rappel. Si vous ne l'avez pas, retrouvez-le avec Lister les rappels.
Exemple rapide#
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'];
}Remplacez 12345 et YOUR_API_KEY par vos propres valeurs. Consultez Authentification pour savoir où les trouver.
Paramètres de la requête#
client_idintegerobligatoireVotre ID client API, dans Paramètres → Clés API.
api_keystringobligatoireVotre clé API, sur cette même page.
reminder_idstringobligatoireID du rappel à annuler, tel que renvoyé par Créer un rappel ou Lister les rappels. Il doit appartenir au même espace de travail que la clé API.
Envoyer des champs de formulaire évite le problème, car chaque valeur de formulaire est une chaîne :
curl -X POST https://wbiztool.com/api/v1/reminder/cancel/ \
-d client_id=12345 \
-d api_key=YOUR_API_KEY \
-d reminder_id=3187
Réponse#
Une requête réussie renvoie le code HTTP 200 :
{
"message": "Reminder cancelled successfully",
"status": 1
}
| Champ | Type | Description |
|---|---|---|
status | integer | 1 si le rappel a été annulé, 0 si la requête a échoué. |
message | string | Reminder cancelled successfully, sinon l'erreur. |
Erreurs#
Les erreurs renvoient le code HTTP 400 avec status à 0, sauf indication contraire :
{ "status": 0, "message": "Reminder not found" }
| Message | Comment corriger |
|---|---|
Invalid JSON format: … | Le corps JSON n'est pas valide. Vous obtenez aussi ce message pour une requête de formulaire sans client_id, ou pour toute requête GET. |
Reminder ID cannot be null | Ajoutez reminder_id. |
Auth Error - Please send correct API key and Client id | Envoyez à la fois client_id et api_key. |
Invalid client id | Envoyez client_id sous forme de nombre. |
Invalid reminder id | reminder_id doit être un nombre entier, comme 3187. |
Auth Error: invalid api key | La clé appartient à un autre client_id. |
Auth Error: please check client id | La clé n'est liée à aucun espace de travail. Créez une nouvelle clé dans l'espace de travail que vous souhaitez utiliser. |
Demo Account cannot access APIs | Utilisez un compte standard. |
Upgrade your plan to use reminders feature | Votre forfait n'inclut pas les rappels. Les rappels créés auparavant continuent de s'exécuter et de consommer des crédits, et ils ne peuvent être ni annulés ni mis en pause, que ce soit via l'API ou le tableau de bord, tant que vous ne passez pas à un forfait supérieur. |
Reminder not found (HTTP 404) | L'ID n'existe pas, appartient à un autre espace de travail, ou le rappel a déjà été annulé. |
Error cancelling reminder: … (HTTP 500) | Un problème est survenu de notre côté. Réessayez. |
Si l'api_key n'existe pas ou a été supprimée, la réponse est une page d'erreur HTML avec le code HTTP 500 au lieu de JSON. Testez votre clé avec Vérifier les identifiants.
Effets de l'annulation#
- Le rappel s'arrête immédiatement et ne s'exécutera plus. Les rappels en pause peuvent aussi être annulés.
- Il disparaît de Lister les rappels et de la page Rappels.
- Un rappel annulé ne peut pas être restauré. Pour recommencer, créez un nouveau rappel.
- Un message que le rappel avait déjà mis en file d'attente avant l'annulation n'est pas supprimé et peut encore être envoyé.
Conseils#
- Annuler deux fois renvoie
Reminder not found. Si vous réessayez des requêtes, interprétez ce message comme « déjà annulé ». - La mise en pause n'est pas disponible via l'API. Pour arrêter temporairement un rappel, mettez-le plutôt en pause sur la page Rappels.
- Modifier une planification : il n'existe pas d'API de mise à jour. Annulez le rappel et créez-en un nouveau avec la nouvelle
cron_expression.
