Saltar al contenido
Wbiztool

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.

POSThttps://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"
  }'

Sustituye 12345 y YOUR_API_KEY por tus propios valores. Consulta Autenticación para saber dónde encontrarlos.

Parámetros de la solicitud#

client_idintegerobligatorio

Tu ID de cliente de la API, de Configuración → Claves API.

api_keystringobligatorio

Tu clave API, de esa misma página.

reminder_idstringobligatorio

ID 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
}
CampoTipoDescripción
statusinteger1 si se canceló el recordatorio, 0 si la solicitud falló.
messagestringReminder 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" }
MensajeCó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 nullAñade reminder_id.
Auth Error - Please send correct API key and Client idEnvía client_id y api_key.
Invalid client idEnvía client_id como número.
Invalid reminder idreminder_id debe ser un número entero, como 3187.
Auth Error: invalid api keyLa clave pertenece a otro client_id.
Auth Error: please check client idLa 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 APIsUsa una cuenta normal.
Upgrade your plan to use reminders featureTu 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.