Skip to content
Wbiztool

Reminders API

Cancel reminder API

Stop a recurring reminder so it never runs again. Use it when a customer pays, a subscription ends or an automation is no longer needed.

POSThttps://wbiztool.com/api/v1/reminder/cancel/

Body: JSON or form fields

You need the reminder_id returned by Create reminder. If you don't have it, find it with List reminders.

Quick example#

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"
  }'

Replace 12345 and YOUR_API_KEY with your own values. See Authentication for where to find them.

Request parameters#

client_idintegerrequired

Your API Client ID from Settings → API keys.

api_keystringrequired

Your API key from the same page.

reminder_idstringrequired

ID of the reminder to cancel, as returned by Create reminder or List reminders. It must belong to the same workspace as the API key.

Sending form fields avoids the issue, because every form value is a string:

curl -X POST https://wbiztool.com/api/v1/reminder/cancel/ \
  -d client_id=12345 \
  -d api_key=YOUR_API_KEY \
  -d reminder_id=3187

Response#

A successful request returns HTTP 200:

{
  "message": "Reminder cancelled successfully",
  "status": 1
}
FieldTypeDescription
statusinteger1 if the reminder was cancelled, 0 if the request failed.
messagestringReminder cancelled successfully, otherwise the error.

Errors#

Errors return HTTP 400 with status set to 0, unless noted:

{ "status": 0, "message": "Reminder not found" }
MessageHow to fix it
Invalid JSON format: …The JSON body isn't valid. You also get this for a form request without client_id, or for any GET request.
Reminder ID cannot be nullAdd reminder_id.
Auth Error - Please send correct API key and Client idSend both client_id and api_key.
Invalid client idSend client_id as a number.
Invalid reminder idreminder_id must be a whole number, such as 3187.
Auth Error: invalid api keyThe key belongs to a different client_id.
Auth Error: please check client idThe key isn't linked to a workspace. Create a new key in the workspace you want to use.
Demo Account cannot access APIsUse a regular account.
Upgrade your plan to use reminders featureYour plan doesn't include reminders. Reminders created earlier keep running and using credits, and they can't be cancelled or paused, through the API or the dashboard, until you upgrade.
Reminder not found (HTTP 404)The ID doesn't exist, is in another workspace, or the reminder was already cancelled.
Error cancelling reminder: … (HTTP 500)Something went wrong on our side. Try again.

If the api_key doesn't exist or has been deleted, the response is an HTML error page with HTTP 500 instead of JSON. Test your key with Check credentials.

What cancelling does#

  • The reminder stops immediately and won't run again. Paused reminders can be cancelled too.
  • It disappears from List reminders and the Reminders page.
  • A cancelled reminder can't be restored. To start again, create a new reminder.
  • A message the reminder already queued before you cancelled it is not removed and may still be sent.

Tips#

  • Cancelling twice returns Reminder not found. If you retry requests, treat that message as "already cancelled".
  • Pausing isn't available through the API. To stop a reminder temporarily, pause it on the Reminders page instead.
  • Changing a schedule: there's no update API. Cancel the reminder and create a new one with the new cron_expression.