Create Reminder API

End Point: https://wbiztool.com/api/v1/reminder/create/

Request Type: POST

Download Postman Collection

Required Parameters

• client_id (Integer) - Your Client Id (Given on API Keys page)
• api_key (String) - Your API Key (Given on API Keys page) (Can be sent in Authorization header as Bearer token)
• reminder_name (String) - Name for the reminder (e.g., "Daily Follow-up")
• phone (String) - WhatsApp number (with country code) or group name
• message (String) - Message template/content for the reminder
• cron_expression (String) - Cron expression for scheduling (e.g., "0 9 * * *" for daily at 9 AM)

Optional Parameters

• whatsapp_client (Integer) - Specific WhatsApp client ID to use (optional)
• timezone (String) - Timezone for cron execution (default: UTC). Examples: "UTC", "Asia/Kolkata", "US/Eastern", "Europe/London"
• msg_type (Integer) - Message type: 0=Text (default), 1=Image+Text, 2=File+Text
• img_url (String) - Image URL (required if msg_type=1)
• file_name (String) - File URL or name (required if msg_type=2)
• file_url (String) - File URL (alternative to file_name for msg_type=2)

Cron Expression Examples

Fields in Response

• status (Integer) - 1 for success, 0 for error
• message (String) - Success or error message
• reminder_id (Integer) - ID of the created reminder (only on success)

Example Request (Text Reminder)

{
  "client_id": 12345,
  "api_key": "your-api-key",
  "reminder_name": "Daily Follow-up",
  "phone": "919876543210",
  "message": "Hi! This is your daily reminder to follow up with clients.",
  "cron_expression": "0 9 * * *",
  "timezone": "Asia/Kolkata",
  "msg_type": 0
}

Example Request (Image Reminder)

{
  "client_id": 12345,
  "api_key": "your-api-key",
  "reminder_name": "Weekly Report",
  "phone": "Team Group",
  "message": "Weekly sales report attached",
  "cron_expression": "0 9 * * 1",
  "timezone": "US/Eastern",
  "msg_type": 1,
  "img_url": "https://example.com/weekly-report.jpg"
}

Example Response (Success)

{
  "status": 1,
  "message": "Reminder created successfully",
  "reminder_id": 789
}

Example Response (Error)

{
  "status": 0,
  "message": "Invalid cron expression"
}

cURL Example

curl -X POST "https://wbiztool.com/api/v1/reminder/create/" \
  -H "Content-Type: application/json" \
  -d '{
    "client_id": 12345,
    "api_key": "your-api-key",
    "reminder_name": "Daily Follow-up",
    "phone": "919876543210",
    "message": "Hi! This is your daily reminder.",
    "cron_expression": "0 9 * * *",
    "timezone": "Asia/Kolkata",
    "msg_type": 0
  }'

Python Example

import requests
import json

url = "https://wbiztool.com/api/v1/reminder/create/"

payload = {
    "client_id": 12345,
    "api_key": "your-api-key",
    "reminder_name": "Daily Follow-up",
    "phone": "919876543210",
    "message": "Hi! This is your daily reminder to follow up with clients.",
    "cron_expression": "0 9 * * *",
    "timezone": "Asia/Kolkata",
    "msg_type": 0
}

headers = {
    'Content-Type': 'application/json'
}

response = requests.post(url, headers=headers, data=json.dumps(payload))
print(response.json())

Important Notes

• Reminders feature is only available for paid subscription plans
• Reminders support timezone-aware execution - specify timezone parameter or defaults to UTC
• Supported timezones include: UTC, Asia/Kolkata, US/Eastern, US/Central, US/Mountain, US/Pacific, Europe/London, Europe/Paris, Europe/Berlin, etc.
• Phone numbers should include country code (e.g., 919876543210 for India)
• Group names can be used instead of phone numbers for group messages
• Cron expressions follow standard Unix cron format: Minute Hour Day Month Weekday
• Cron expressions are executed according to the specified timezone
• For image messages (msg_type=1), img_url is mandatory
• For file messages (msg_type=2), either file_name or file_url is mandatory
• Created reminders are automatically set to active status