Skip to main content
PATCH
/
v1
/
documentation
/
blocks
/
{block_id}
cURL
curl --request PATCH \
  --url http://localhost:8000/api/v1/documentation/blocks/{block_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "block_type": "bookmark",
  "content": [
    {
      "annotations": {
        "bold": "<string>",
        "italic": "<string>",
        "strikethrough": "<string>",
        "underline": "<string>",
        "code": "<string>",
        "color": "<string>"
      },
      "plain_text": "<string>",
      "href": "<string>"
    }
  ]
}
'
{
  "data": {
    "block_type": "bookmark",
    "id": "<string>",
    "content": [
      {
        "annotations": {
          "bold": "<string>",
          "italic": "<string>",
          "strikethrough": "<string>",
          "underline": "<string>",
          "code": "<string>",
          "color": "<string>"
        },
        "plain_text": "<string>",
        "href": "<string>"
      }
    ],
    "parent_id": "<string>"
  },
  "meta": {}
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
block_id
string
required

Block id of the block you want to update

Query Parameters

​
raw
boolean

Include raw response. When you want more data from the source

Body

application/json
​
block_type
enum<string>
required

Type of the block

Available options:
bookmark,
breadcrumb,
bulleted_list_item,
callout,
child_database,
child_page,
column,
column_list,
divider,
embed,
equation,
file,
heading_1,
heading_2,
heading_3,
image,
link_preview,
link_to_page,
numbered_list_item,
paragraph,
pdf,
quote,
synced_block,
table,
table_of_contents,
table_row,
template,
to_do,
toggle,
unsupported,
video
​
content
object[]
required

Content of the block

Response

​
data
object
required
​
meta
object