microCMSブログ

microCMSの最新情報や活用事例などをお届けします。

重要なお知らせ

【仕様変更】 コンテンツAPI(PATCH)の機能拡張および仕様変更について

【仕様変更】 コンテンツAPI(PATCH)の機能拡張および仕様変更について
microCMS編集部 microCMS編集部

平素よりmicroCMSをご利用いただき誠にありがとうございます。

この度、2026/2/9(月)のアップデートにて、コンテンツAPIのPATCHリクエストに関する機能拡張および一部の挙動を変更いたします。

 

本告知は、コンテンツAPIのPATCHリクエストに関する、2つの変更内容をご案内するものです。

  1. 【機能拡張】 公開中のコンテンツに対して下書きデータを追加できる機能の追加
  2. 【仕様変更】 リクエスト時の挙動・レスポンス内容の一部変更 

それぞれ性質の異なる変更となりますため、個別に内容をご確認ください。

1. 【機能拡張】 公開中のコンテンツに対して、下書きのデータを追加する機能が追加されます

公開中、または公開中かつ下書き中のコンテンツに対して ?status=draft クエリパラメータを指定して PATCHリクエストを行うと、 リクエストボディに指定した値が下書きとして追加されるようになります。挙動の詳細は以下の通りです。

  • 公開中:公開中かつ下書き中のステータスになり、下書きにコンテンツが追加される
  • 公開中かつ下書き中:公開中かつ下書き中のステータスのまま、下書き中のコンテンツが更新される

影響の可能性があるサービス

コンテンツAPIのPATCHリクエストで、すでに ?status=draft クエリパラメータを使用しているサービス。

影響内容

これまで ?status=draft が指定されていても無視され、公開中のステータスのまま更新されていましたが、公開中かつ下書き中のステータスで更新されます。

推奨される対応

コンテンツAPIのPATCHリクエストで、すでに ?status=draft クエリパラメータを使用している場合はクエリパラメータの見直しをご検討ください。

2. 【仕様変更】 PATCHリクエスト時の挙動・レスポンス内容が一部変更になります

?status=draft クエリパラメータを付与しないPATCHリクエストについて、一部の条件における更新時の挙動を変更いたします。

変更後のPATCHリクエスト時の挙動一覧は以下となります。

コンテンツAPIのリスト形式とオブジェクト形式ごとに、ステータス別のPATCHリクエスト時の挙動をまとめた表。公開終了ステータスでは400が返され更新されないなど、アップデート後の挙動変化を示している。

今回変更が発生する箇所を、以下にテキストで抜粋しています。

リスト形式のAPIかつ公開終了のコンテンツ

  • ステータスコードが200から400に変更になります
  • 挙動は変わらず、更新されません

オブジェクト形式のAPIかつ下書き中のコンテンツ

  • ステータスコードが502から200に変更になります
  • 下書き中のコンテンツが更新されるようになります

オブジェクト形式のAPIかつ公開終了のコンテンツ

  • ステータスコードが502から400に変更になります
  • 挙動は変わらず、更新されません

影響の可能性があるサービス

以下の条件に該当する場合、今回の仕様変更により影響が発生する可能性があります。

  • リスト形式のAPIで、公開終了ステータスのコンテンツに対してPATCHリクエストを行っている
  • オブジェクト形式のAPIで、下書き中または公開終了ステータスのコンテンツに対してPATCHリクエストを行っている

影響内容

下書き中もしくは公開終了のステータスのコンテンツに対して、PATCHリクエストをしている場合、レスポンスが変更になる可能性があります。

※リスト形式のAPIかつ下書き中ステータスのコンテンツにPATCHリクエストをしている場合は、従来どおりレスポンスは変更されません。

推奨される対応

下書き中や公開終了のコンテンツにPATCHリクエストを行っている場合、レスポンスの変更に応じた対応をご検討ください。

変更予定日

2026/2/9(月)を予定しております。 

※ 不具合や想定外の事項があった場合、リリース日は変更となる可能性がございます。

本件に関するお問い合わせ先

本件に関してご不明点がございます場合は、お問い合わせフォームよりご連絡ください。

今後もより使いやすいサービスになるよう改善を続けてまいります。

今後とも、microCMSをご愛顧賜りますようお願い申し上げます。

まずは、無料で
試してみましょう。

microCMSは無料ではじめられます。
ご不明な点はお気軽にお問い合わせください。