Skip to navigation
EndpointsBlocks

Update a block

Updates the content for the specified block_id based on the block type. Supported fields based on the block object type (see Block object for available fields and the expected input for each field).

Note: The update replaces the entire value for a given field. If a field is omitted (ex: omitting checked when updating a to_do block), the value will not be changed.

Updating child_page blocks

To update child_page type blocks, use the Update page endpoint. Updating the page’s title updates the text displayed in the associated child_page block.

Updating child_database blocks

To update child_database type blocks, use the Update database endpoint. Updating the page’s title updates the text displayed in the associated child_database block.

Updating children

A block’s children CANNOT be directly updated with this endpoint. Instead use Append block children to add children.

Updating heading blocks

To update the toggle of a heading block, you can include the optional is_toggleable property in the request. Toggle can be added and removed from a heading block. However, you cannot remove toggle from a heading block if it has children. All children MUST be removed before revoking toggle from a heading block.

Success

Returns a 200 HTTP response containing the updated block object on success.

Integration capabilities

This endpoint requires an integration to have update content capabilities. Attempting to call this API without update content capabilities will return an HTTP response with a 403 status code. For more information on integration capabilities, see the capabilities guide.

Errors

Returns a 404 HTTP response if the block doesn’t exist, has been archived, or if the integration doesn’t have access to the page.

Returns a 400 if the type for the block is incorrect or the input is incorrect for a given field.

Returns a 400 or a 429 HTTP response if the request exceeds the request limits.

Note: Each Public API endpoint can return several possible error codes. See the Error codes section of the Status codes documentation for more information.

Path parameters

block_idstringRequired
Identifier for a Notion block

Headers

Notion-VersionstringRequired

The API version to use for this request. The latest version is <<latestNotionVersion>>.

Request

This endpoint expects an object.
{type}objectOptional

The block object type value with the properties to be updated. Currently only text (for supported block types) and checked (for to_do blocks) fields can be updated.

archivedbooleanOptionalDefaults to true

Set to true to archive (delete) a block. Set to false to un-archive (restore) a block.

Response

200
objectstringOptional
idstringOptional
parentobjectOptional
created_timestringOptional
last_edited_timestringOptional
created_byobjectOptional
last_edited_byobjectOptional
has_childrenbooleanOptionalDefaults to true
archivedbooleanOptionalDefaults to true
typestringOptional
heading_2objectOptional

Errors

400
Bad Request Error