Langsung ke konten
WbizTool

API Pengingat

API Batalkan pengingat

Hentikan pengingat berulang agar tidak pernah dijalankan lagi. Gunakan saat pelanggan sudah membayar, langganan berakhir, atau otomatisasi tidak lagi diperlukan.

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

Body: JSON atau field formulir

Anda memerlukan reminder_id yang dikembalikan oleh Buat pengingat. Jika Anda tidak memilikinya, temukan dengan Daftar pengingat.

Contoh singkat#

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

Ganti 12345 dan YOUR_API_KEY dengan nilai Anda sendiri. Lihat Autentikasi untuk mengetahui di mana menemukannya.

Parameter request#

AuthorizationheaderDisarankan

Bearer YOUR_API_KEY: kunci API Anda dari Pengaturan → Kunci API. Dengan header ini, client_id dan api_key boleh tidak dikirim di body; jika keduanya dikirim, kunci valid di header yang dipakai. Lihat Mengirim kunci di header.

client_idintegerTanpa header Authorization

API Client ID Anda dari Pengaturan → Kunci API. Opsional jika memakai header; jika Anda mengirimnya, nilainya harus Client ID workspace kunci tersebut.

api_keystringTanpa header Authorization

Kunci API Anda dari halaman yang sama, jika Anda tidak mengirimnya di header.

reminder_idstringwajib

ID pengingat yang akan dibatalkan, seperti yang dikembalikan oleh Buat pengingat atau Daftar pengingat. ID ini harus termasuk dalam workspace yang sama dengan kunci API.

Anda juga dapat mengirim field formulir sebagai pengganti JSON:

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

Respons#

Request yang berhasil mengembalikan HTTP 200:

{
  "message": "Reminder cancelled successfully",
  "status": 1
}
FieldTipeDeskripsi
statusinteger1 jika pengingat dibatalkan, 0 jika request gagal.
messagestringReminder cancelled successfully, selain itu berisi error.

Error#

Error mengembalikan HTTP 400 dengan status bernilai 0, kecuali disebutkan lain:

{ "status": 0, "message": "Reminder not found" }
PesanCara memperbaikinya
Invalid JSON format: …Body JSON tidak valid. Anda juga mendapatkan error ini untuk request formulir tanpa client_id, atau untuk request GET apa pun.
Reminder ID cannot be nullTambahkan reminder_id.
Auth Error - Please send correct API key and Client idKirim client_id dan api_key.
Invalid client idKirim client_id sebagai angka.
Invalid reminder idreminder_id harus berupa bilangan bulat, misalnya 3187.
Auth Error: invalid api keyKunci tersebut tidak ada, sudah dihapus, atau milik client_id lain. Uji kunci Anda dengan Cek kredensial.
Auth Error: please check client idKunci tidak terhubung ke workspace. Buat kunci baru di workspace yang ingin Anda gunakan.
Demo Account cannot access APIsGunakan akun biasa.
Upgrade your plan to use reminders featurePaket Anda tidak mencakup pengingat. Pengingat yang dibuat sebelumnya tetap berjalan dan mengirim pesan, dan tidak dapat dibatalkan atau dijeda, baik melalui API maupun dashboard, sampai Anda melakukan upgrade.
Reminder not found (HTTP 404)ID tidak ada, berada di workspace lain, atau pengingat sudah dibatalkan.
Error cancelling reminder: … (HTTP 500)Terjadi masalah di sisi kami. Coba lagi.

Apa yang terjadi saat membatalkan#

  • Pengingat langsung berhenti dan tidak akan dijalankan lagi. Pengingat yang sedang dijeda juga dapat dibatalkan.
  • Pengingat hilang dari Daftar pengingat dan halaman Reminders (Pengingat).
  • Pengingat yang dibatalkan tidak dapat dipulihkan. Untuk memulai lagi, buat pengingat baru.
  • Pesan yang sudah dimasukkan ke antrean oleh pengingat sebelum Anda membatalkannya tidak dihapus dan mungkin tetap terkirim.

Tips#

  • Membatalkan dua kali mengembalikan Reminder not found. Jika Anda mencoba ulang request, anggap pesan tersebut berarti "sudah dibatalkan".
  • Menjeda tidak tersedia melalui API. Untuk menghentikan pengingat sementara, jeda di halaman Reminders.
  • Mengubah jadwal: tidak ada API untuk memperbarui. Batalkan pengingat dan buat yang baru dengan cron_expression baru.