1. ヘルプ
  2. 機能
  3. コンテンツAPI(WRITE)

PATCH APIでコンテンツを更新する際、すべてのフィールドを指定する必要がありますか?

すべてのフィールドを指定する必要はありません。更新したいフィールドだけを指定してください。

繰り返しフィールド内のフィールドを更新する場合は、繰り返しフィールド内のすべてのフィールドを指定する必要があります。

詳しくは以下のヘルプをご参照ください。

PATCH APIで繰り返しフィールド内の特定のフィールドの値を更新する際はどのように指定すればいいですか?

指定方法

例えば、以下のようなコンテンツでtitleの値のみ更新する場合を考えます。

{
  "id": "1zw6zpdui1",
  "createdAt": "2024-06-26T07:08:47.440Z",
  "updatedAt": "2024-06-28T04:59:16.754Z",
  "publishedAt": "2024-06-26T07:08:47.440Z",
  "revisedAt": "2024-06-28T04:59:16.754Z",
"title": "更新前のタイトル",
  "body": "<p>本文が入ります。</p>"
}

titleのみ更新する際のリクエストボディ

リクエストボディには更新したいtitleのみを指定します。

{
"title": "更新後のタイトル"
}

更新後のコンテンツ

他のフィールドの値は更新されず、titleの値のみが更新されます。

{
    "id": "1zw6zpdui1",
    "createdAt": "2024-06-26T07:08:47.440Z",
    "updatedAt": "2024-06-28T05:29:13.294Z",
    "publishedAt": "2024-06-26T07:08:47.440Z",
    "revisedAt": "2024-06-28T05:29:13.294Z",
   "title": "更新後のタイトル",
    "body": "<p>本文が入ります。</p>"
}