Skip to main content

Overview

Updates the properties of an existing database. You can modify the title, description, icon, cover, parent, inline status, trash status, and lock status.

Parameters

string
required
The ID of the database to update.
array
The updated title of the database as an array of rich text objects. If not provided, the title will not be updated.
array
The updated description of the database as an array of rich text objects. If not provided, the description will not be updated.
boolean
Whether the database should be displayed inline in the parent page. If not provided, the inline status will not be updated.
object
The updated icon for the database. Can be an emoji, external URL, or file upload. If not provided, the icon will not be updated.
object
The updated cover image for the database. Can be an external URL or file upload. If not provided, the cover will not be updated.
boolean
Whether the database should be moved to or from the trash. If not provided, the trash status will not be updated.
boolean
Whether the database should be locked from editing in the Notion app UI. If not provided, the locked state will not be updated.
object
The parent page or workspace to move the database to. If not provided, the database will not be moved.
string
Optional authentication token to override the client’s default token for this request.

Response

Returns a DatabaseObjectResponse or PartialDatabaseObjectResponse with the updated properties.
string
Always database.
string
The ID of the database.
array
The updated title of the database.
array
The updated description of the database.
boolean
The updated inline status.
boolean
The updated trash status.
boolean
The updated locked status.
object
The updated parent of the database.
object
The updated icon.
object
The updated cover image.
string
ISO 8601 timestamp when the database was last edited (updated).

Examples

Update database title and description

Update database icon and cover

Move database to trash

Restore database from trash

Lock database

Move database to different parent

Toggle inline status

All update parameters are optional. Only the properties you specify will be updated.