(日本語版)Notion API - Public Beta
  1. ブロック
(日本語版)Notion API - Public Beta
  • 概要
  • インテグレーション機能
  • リクエスト制限
  • ステータス コード
  • ブロック
  • ユーザー
  • コメント
  • リンク プレビューのUnfurl属性オブジェクト
  • バージョン変更
    • バージョニング
    • バージョンによる変更
  • ページ
    • ページ
    • ページのプロパティ
  • データベース
    • データベース
    • データベースのプロパティ
  • その他
    • 絵文字オブジェクト
    • ファイルオブジェクト
    • 親オブジェクト
    • リッチテキストオブジェクト
  • エンドポイント
    • 認証
      • 認証
      • Tokenを作成
    • ブロック
      • ブロックを取得
        GET
      • ブロックを更新
        PATCH
      • ブロックの子を取得
        GET
      • ブロックの子を追加
        PATCH
      • ブロックを削除
        DELETE
    • データベース
      • データベース エントリのフィルタ
      • データベース エントリの並べ替え
      • データベースのプロパティを更新する
      • データベースを作成
      • データベースを取得
      • データベースを更新
      • データベースにクエリを実行
    • ユーザー
      • 全てユーザーのリストを取得
      • トークンのボットユーザーを取得
      • ユーザーを取得
    • ページ
      • ページをアーカイブ
      • ページを作成
      • ページを取得
      • ページプロパティアイテムを取得
      • ページプロパティを更新
    • コメント
      • コメントを作成
      • コメントを取得
    • 検索
      • タイトルで検索
  1. ブロック

ブロックを更新

PATCH
/v1/blocks/{block_id}
Blocks
ブロック タイプに基づいて、指定された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 Request Example
Shell
JavaScript
Java
Swift
curl --location --request PATCH 'https://api.notion.com/v1/blocks/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "paragraph": {
        "text": [
            {
                "text": {
                    "content": "hello to you"
                },
                "type": "text"
            }
        ]
    }
}'
Response Response Example
{
  "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
  }
}

Requestパラメータ

Pathパラメータ
block_id
string 
必須
Request Bodyパラメータapplication/json
{type}
object 
可選
更新するプロパティを持つブロックオブジェクトの値。type現在、text(サポートされているブロック タイプの場合) およびchecked(to_doブロックの場合) フィールドのみを更新できます。
rich_text
array [object {1}] 
必須
checked
boolean 
必須
archived
boolean 
可選
ブロックをアーカイブ (削除) するには、true に設定します。ブロックをアーカイブ解除 (復元) するには、false に設定します。
Examples

Response

🟢200200 Success - Update a block
application/json
Body
created_time
string 
必須
has_children
boolean 
必須
id
string 
必須
last_edited_time
string 
必須
object
string 
必須
paragraph
object 
可選
text
array [object {5}] 
可選
type
string 
必須
parent
object 
必須
type
string 
必須
page_id
string 
必須
created_by
object 
必須
object
string 
必須
id
string 
必須
last_edited_by
object 
必須
object
string 
必須
id
string 
必須
archived
boolean 
必須
heading_2
object 
必須
rich_text
array [object {5}] 
必須
color
string 
必須
is_toggleable
boolean 
必須
更新日時 2023-04-28 08:37:14
前へ
ブロックを取得
次へ
ブロックの子を取得
Built with