Reminders

Create a recurring reminder

Create a message that is queued automatically whenever a five-field cron expression matches in the reminder's IANA timezone. Needs a plan that includes reminders. Send text values as JSON strings: a number, true or null in a text field returns an HTML error page (HTTP 500).

post/reminder/create/

Request

  • Base URL: https://wbiztool.com/api/v1
  • URL: https://wbiztool.com/api/v1/reminder/create/
  • Auth: none required

Request body

client_idinteger required

Your API Client ID from Settings → API keys.

api_keystring required

One of your API keys from the same page. Keep it secret.

whatsapp_clientinteger

ID of the WhatsApp number (or Telegram account) to send from, shown as "ID …" on the number's card on WhatsApp numbers in the dashboard.

reminder_namestring required
phonestring required

Recipient number with its country code (no separate country_code), a WhatsApp group name, or a Telegram @username/t.me link/tg:<id>.

messagestring required

Message text; may contain template variables such as {current_date_formatted} or {reminder_name}.

cron_expressionstring required

Five-field cron expression (minute hour day month weekday), no seconds or @daily shortcuts.

timezonestring

IANA timezone name such as Asia/Kolkata. Abbreviations like IST are refused.

msg_type0 | 1 | 2

0 text (default), 1 image, 2 file or document.

img_urlstring uri

Public URL of the image (msg_type 1) or of the file (msg_type 2). Downloaded on every run.

file_namestring

For msg_type 2: the file name with its extension.

Example request

{
  "client_id": 12345,
  "api_key": "YOUR_API_KEY",
  "whatsapp_client": 678,
  "reminder_name": "Monthly rent reminder",
  "phone": "919876543210",
  "cron_expression": "0 10 1 * *",
  "timezone": "Asia/Kolkata"
}

Response

Reminder created and active.

status1 required
message'Reminder created successfully' required
reminder_idinteger required

Changes

No recorded changes to this operation across all 1 revision of this API.