PATCH /v1/databases/{database_id}

Update a database

Servers

Path parameters

Name Type Required Description
database_id String Yes

identifier for a Notion database

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
description[] Array No

An array of rich text objects that represents the description of the database that is displayed in the Notion UI. If omitted, then the database description remains unchanged.

description[].text Object Yes
description[].text.content String Yes
description[].text.link Object No
description[].text.link.url String Yes
description[].type String No

Valid values:

  • "text"
properties Object No

Property schema of database. The keys are the names of properties as they appear in Notion and the values are property schema objects.

properties.name String No
title[] Array No

An array of rich text objects that represents the title of the database that is displayed in the Notion UI. If omitted, then the database title remains unchanged.

title[].text Object Yes
title[].text.content String Yes
title[].text.link Object No
title[].text.link.url String Yes
title[].type String No

Valid values:

  • "text"

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.