ブロックを更新
PATCH/v1/blocks/{block_id}ブロック タイプに基づいて、指定されたblock_id のコンテンツを更新します。ブロック オブジェクトの種類に基づいてサポートされるフィールド (使用可能なフィールドと各フィールドに期待される入力については、ブロック オブジェクトを参照してください)。
注: 更新により、特定のフィールドの値全体が置き換えられます。フィールドが省略された場合 (例:to_doブロックの更新時にcheckedを省略)、値は変更されません。
📘
child_pageブロックの更新
child_page型ブロックを更新するには、更新ページエンドポイントを使用します。ページのtitleを更新すると、関連するchild_pageブロックに表示されるテキストが更新されます。
📘
child_databaseブロックの更新
child_database型ブロックを更新するには、 Update データベースエンドポイントを使用します。ページのtitleを更新すると、関連するchild_databaseブロックに表示されるテキストが更新されます。
📘
children更新ブロックの子は、このエンドポイントで直接更新できません。代わりにAppend ブロックの子を使用して子を追加します。
📘
headingブロックの更新
headingブロックのトグルを更新するには、オプションのis_toggleableプロパティをリクエストに含めることができます。トグルは、headingブロックに追加および削除できます。ただし、headingブロックに子がある場合、ブロックからトグルを削除することはできません。headingブロックからトグルを取り消す前に、すべての子を削除する必要があります。
成功
成功すると、更新されたブロック オブジェクトを含む 200 HTTP 応答を返します。
📘統合機能
このエンドポイントでは、コンテンツの更新機能を備えた統合が必要です。更新コンテンツ機能なしでこの API を呼び出そうとすると、403 ステータス コードを含む HTTP 応答が返されます。統合機能の詳細については、機能ガイドを参照してください。
エラー
ブロックが存在しない場合、アーカイブされている場合、または統合がページにアクセスできない場合は、404 HTTP 応答を返します。
ブロックのtype が正しくない場合、または特定のフィールドの入力が正しくない場合は、400 を返します。
リクエストがリクエスト制限を超えた場合、400 または 429 HTTP レスポンスを返します。
Requestパラメータ
更新するプロパティを持つブロックオブジェクトの値。type現在、text(サポートされているブロック タイプの場合) およびchecked(to_doブロックの場合) フィールドのみを更新できます。
ブロックをアーカイブ (削除) するには、true に設定します。ブロックをアーカイブ解除 (復元) するには、false に設定します。
{
"paragraph": {
"text": [
{
"text": {
"content": "hello to you"
},
"type": "text"
}
]
}
}サンプルコード
Response
{
"object": "block",
"id": "c02fc1d3-db8b-45c5-a222-27595b15aea7",
"parent": {
"type": "page_id",
"page_id": "59833787-2cf9-4fdf-8782-e53db20768a5"
},
"created_time": "2022-03-01T19:05:00.000Z",
"last_edited_time": "2022-07-06T19:41:00.000Z",
"created_by": {
"object": "user",
"id": "ee5f0f84-409a-440f-983a-a5315961c6e4"
},
"last_edited_by": {
"object": "user",
"id": "ee5f0f84-409a-440f-983a-a5315961c6e4"
},
"has_children": false,
"archived": false,
"type": "heading_2",
"heading_2": {
"rich_text": [
{
"type": "text",
"text": {
"content": "Lacinato kale",
"link": null
},
"annotations": {
"bold": false,
"italic": false,
"strikethrough": false,
"underline": false,
"code": false,
"color": "green"
},
"plain_text": "Lacinato kale",
"href": null
}
],
"color": "default",
"is_toggleable": false
}
}