Skip to navigation
EndpointsPages

Update page properties

Updates the properties of a page in a database. The properties body param of this endpoint can only be used to update the properties of a page that is a child of a database. The page’s properties schema must match the parent database’s properties.

This endpoint can be used to update any page icon or cover, and can be used to delete or restore any page.

To add page content instead of page properties, use the append block children endpoint. The page_id can be passed as the block_id when adding block children to the page.

Returns the updated page object.

Requirements

Your integration must have update content capabilities on the target page in order to call this endpoint. To update your integrations capabilities, navigation to the My integrations dashboard, select your integration, go to the Capabilities tab, and update your settings as needed.

Attempting a query without update content capabilities returns an HTTP response with a 403 status code.

Limitations

Errors

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

page_idstringRequired
The identifier for the Notion page to be updated.

Headers

Notion-VersionstringRequired

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

Request

This endpoint expects an object.
propertiesstringOptionalformat: "json"
The property values to update for the page. The keys are the names or IDs of the property and the values are property values. If a page property ID is not included, then it is not changed.
in_trashbooleanOptionalDefaults to false
Set to true to delete a block. Set to false to restore a block.
iconstringOptionalformat: "json"

A page icon for the page. Supported types are external file object or emoji object.

coverstringOptionalformat: "json"

A cover image for the page. Only external file objects are supported.

is_lockedbooleanOptional
Whether the page should be locked from editing in the Notion app UI. If not provided, the locked state will not be updated.

Response

200
objectstringOptional
idstringOptional
created_timestringOptional
last_edited_timestringOptional
created_byobjectOptional
last_edited_byobjectOptional
coverobjectOptional
iconobjectOptional
parentobjectOptional
archivedbooleanOptionalDefaults to true
is_lockedbooleanOptionalDefaults to true
propertiesobjectOptional
urlstringOptional

Errors

400
Bad Request Error
404
Not Found Error
429
Too Many Requests Error