公開APIの仕様変更についてのQ&A

本ページでは公開APIの仕様変更に関するQ&Aを掲載しております。
仕様変更の詳細については、以下ページをご参照ください。

2025/04/03 APIリクエストの仕様変更についてのお知らせ」 
API ドキュメント- 2025/04/03 APIリクエストの仕様変更についてのお知らせ

目次

今回のAPIの変更点は何ですか?

  • POSTおよびPUTメソッドの操作についてクエリパラメーターを受け付けなくなります
  • method パラメーターによるHTTPメソッドの指定を廃止します

    詳しくは「2025/04/03 APIリクエストの仕様変更についてのお知らせ」をご確認ください。

旧バージョンのAPIはいつまで使えますか?

7月2日までご利用できます。

変更によって既存のシステムに影響はありますか?

POSTおよびPUTメソッドの操作でクエリパラメーターを利用している場合、エラーが発生します。

既存のAPIキーやトークンはそのまま使えますか?

はい、既存のAPIキーやトークンはそのまま使用できます。

サードパーティのサービスにAPIトークンを提供して公開APIを使用しているのですがどうしたらいいですか?

お手数ですが、APIトークンの提供先に「2025/04/03 APIリクエストの仕様変更についてのお知らせ」のURLを連携いただけますと助かります。

GASを使用したChatworkの連携は本仕様変更に影響はありますか?

お客様自身で組まれているプログラムの内容により影響有無が異なります。
そのため、お手数ではございますが、お客様にて各プログラムをご確認いただくようお願いいたします。なお、GASの連携設定内容につきましては、サポート対象外となりますこと、ご了承ください。

body 以外のクエリパラメータ(オプション項目など)を指定した場合でも、仕様変更後はエラーになりますか?

2025年7月3日以降、POSTおよびPUTリクエストに含まれるすべてのクエリパラメータは無効になります。
body 以外のクエリパラメータも読み取られませんが、必須のボディパラメータが正しく指定されていればリクエストは正常に処理されます。ボディパラメータが不足している場合は、エラーとなります。