API de recordatorios
API para cancelar un recordatorio
Detén un recordatorio recurrente para que no vuelva a ejecutarse. Úsala cuando un cliente paga, termina una suscripción o una automatización ya no hace falta.
https://wbiztool.com/api/v1/reminder/cancel/Cuerpo: JSON o campos de formulario
Necesitas el reminder_id que devolvió Crear recordatorio. Si no lo tienes, búscalo con Listar recordatorios.
Ejemplo rápido#
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'];
}Sustituye 12345 y YOUR_API_KEY por tus propios valores. Consulta Autenticación para saber dónde encontrarlos.
Parámetros de la solicitud#
client_idintegerobligatorioTu ID de cliente de la API, de Configuración → Claves API.
api_keystringobligatorioTu clave API, de esa misma página.
reminder_idstringobligatorioID del recordatorio que quieres cancelar, tal como lo devuelve Crear recordatorio o Listar recordatorios. Debe pertenecer al mismo espacio de trabajo que la clave API.
Enviar campos de formulario evita el problema, porque todos los valores de formulario son cadenas:
curl -X POST https://wbiztool.com/api/v1/reminder/cancel/ \
-d client_id=12345 \
-d api_key=YOUR_API_KEY \
-d reminder_id=3187
Respuesta#
Una solicitud correcta devuelve HTTP 200:
{
"message": "Reminder cancelled successfully",
"status": 1
}
| Campo | Tipo | Descripción |
|---|---|---|
status | integer | 1 si se canceló el recordatorio, 0 si la solicitud falló. |
message | string | Reminder cancelled successfully; en caso contrario, el error. |
Errores#
Los errores devuelven HTTP 400 con status con valor 0, salvo que se indique lo contrario:
{ "status": 0, "message": "Reminder not found" }
| Mensaje | Cómo solucionarlo |
|---|---|
Invalid JSON format: … | El cuerpo JSON no es válido. También recibes este error en una solicitud de formulario sin client_id o en cualquier solicitud GET. |
Reminder ID cannot be null | Añade reminder_id. |
Auth Error - Please send correct API key and Client id | Envía client_id y api_key. |
Invalid client id | Envía client_id como número. |
Invalid reminder id | reminder_id debe ser un número entero, como 3187. |
Auth Error: invalid api key | La clave pertenece a otro client_id. |
Auth Error: please check client id | La clave no está vinculada a ningún espacio de trabajo. Crea una clave nueva en el espacio de trabajo que quieras usar. |
Demo Account cannot access APIs | Usa una cuenta normal. |
Upgrade your plan to use reminders feature | Tu plan no incluye recordatorios. Los recordatorios creados antes siguen ejecutándose y consumiendo créditos, y no se pueden cancelar ni pausar, ni por la API ni desde el panel, hasta que mejores tu plan. |
Reminder not found (HTTP 404) | El ID no existe, está en otro espacio de trabajo o el recordatorio ya se canceló. |
Error cancelling reminder: … (HTTP 500) | Algo falló por nuestra parte. Vuelve a intentarlo. |
Si el api_key no existe o se ha eliminado, la respuesta es una página de error HTML con HTTP 500 en lugar de JSON. Prueba tu clave con Comprobar credenciales.
Qué hace la cancelación#
- El recordatorio se detiene de inmediato y no vuelve a ejecutarse. Los recordatorios pausados también se pueden cancelar.
- Desaparece de Listar recordatorios y de la página de Recordatorios.
- Un recordatorio cancelado no se puede restaurar. Para empezar de nuevo, crea un recordatorio nuevo.
- Un mensaje que el recordatorio ya había puesto en cola antes de cancelarlo no se elimina y puede llegar a enviarse.
Consejos#
- Cancelar dos veces devuelve
Reminder not found. Si reintentas solicitudes, interpreta ese mensaje como «ya cancelado». - Pausar no está disponible a través de la API. Para detener un recordatorio temporalmente, páusalo en la página de Recordatorios.
- Cambiar una programación: no hay API de actualización. Cancela el recordatorio y crea uno nuevo con la nueva
cron_expression.
