コンテンツへスキップ
Wbiztool

リマインダーAPI

リマインダーのキャンセルAPI

繰り返しのリマインダーを停止し、二度と実行されないようにします。お客様の支払いが完了したとき、サブスクリプションが終了したとき、自動化が不要になったときなどに利用できます。

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

リクエストボディ: JSONまたはフォームフィールド

リマインダーの作成で返されたreminder_idが必要です。手元にない場合は、リマインダー一覧で確認してください。

クイック例#

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

12345YOUR_API_KEYはご自身の値に置き換えてください。値の確認場所は認証をご覧ください。

リクエストパラメータ#

client_idinteger必須

設定 → APIキーに表示されるAPIクライアントIDです。

api_keystring必須

同じページにあるAPIキーです。

reminder_idstring必須

キャンセルするリマインダーのIDで、リマインダーの作成またはリマインダー一覧で返されたものです。APIキーと同じワークスペースに属している必要があります。

フォームフィールドの値はすべて文字列になるため、フォームフィールドで送信するとこの問題を回避できます。

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

レスポンス#

リクエストが成功すると、HTTP 200が返ります。

{
  "message": "Reminder cancelled successfully",
  "status": 1
}
フィールド説明
statusintegerリマインダーがキャンセルされた場合は1、リクエストが失敗した場合は0
messagestringReminder cancelled successfully、それ以外はエラー内容。

エラー#

特に記載がない限り、エラーはHTTP 400で返り、status0になります。

{ "status": 0, "message": "Reminder not found" }
メッセージ対処方法
Invalid JSON format: …JSONボディが無効です。client_idなしのフォームリクエストや、すべてのGETリクエストでもこのエラーになります。
Reminder ID cannot be nullreminder_idを追加してください。
Auth Error - Please send correct API key and Client idclient_idapi_keyの両方を送信してください。
Invalid client idclient_idを数値で送信してください。
Invalid reminder idreminder_id3187のような整数である必要があります。
Auth Error: invalid api keyキーが別のclient_idに属しています。
Auth Error: please check client idキーがワークスペースに紐付いていません。使用したいワークスペースで新しいキーを作成してください。
Demo Account cannot access APIs通常のアカウントを使用してください。
Upgrade your plan to use reminders featureご利用のプランにはリマインダーが含まれていません。以前に作成したリマインダーは引き続き実行されてクレジットを消費しますが、アップグレードするまで、APIでもダッシュボードでもキャンセルや一時停止はできません。
Reminder not found(HTTP 404IDが存在しない、別のワークスペースにある、またはリマインダーがすでにキャンセルされています。
Error cancelling reminder: …(HTTP 500サーバー側で問題が発生しました。もう一度お試しください。

api_keyが存在しないか削除されている場合、レスポンスはJSONではなく、HTTP 500のHTMLエラーページになります。認証情報の確認でキーをテストしてください。

キャンセルするとどうなるか#

  • リマインダーはすぐに停止し、二度と実行されません。一時停止中のリマインダーもキャンセルできます。
  • リマインダー一覧リマインダーページから表示されなくなります。
  • キャンセルしたリマインダーは元に戻せません。再開するには、新しいリマインダーを作成してください。
  • キャンセル前にリマインダーがすでにキューに登録したメッセージは削除されず、送信される可能性があります。

ヒント#

  • 2回キャンセルするReminder not foundが返ります。リクエストを再試行する場合は、このメッセージを「キャンセル済み」として扱ってください。
  • 一時停止はAPIでは利用できません。リマインダーを一時的に止めるには、代わりにリマインダーページで一時停止してください。
  • スケジュールの変更:更新用のAPIはありません。リマインダーをキャンセルし、新しいcron_expressionで新しいリマインダーを作成してください。