dataSources.update

Method

client.dataSources.update(parameters: UpdateDataSourceParameters): Promise<DataSourceObjectResponse | PartialDataSourceObjectResponse>

Updates the properties, title, icon, or parent of a data source.

Parameters

string

required

The ID of the data source to update (with or without dashes)

RichTextItemRequest[]

New title of the data source as it appears in Notion. Array of rich text objects.

PageIconRequest | null

New icon for the data source. Set to null to remove the icon.

Record<string, PropertyConfiguration | { name: string } | null>

The property schema updates for the data source.

To add or update a property, provide its configuration
To rename a property, provide { name: "New Name" }
To remove a property, set it to null

Each property can have a name and description field along with its type-specific configuration.

boolean

Whether to move the data source to or from the trash. Equivalent to in_trash.

boolean

Whether to move the data source to or from the trash. Equivalent to archived.

object

The parent of the data source, when moving it to a different database.

string

default:"database_id"

Always database_id

string

required

The ID of the new parent database

string

Bearer token for authentication. Overrides the client-level auth if provided.

Response

Returns the updated DataSourceObjectResponse or PartialDataSourceObjectResponse.

string

Always "data_source"

string

The unique identifier of the data source

RichTextItemResponse[]

The updated title of the data source

Record<string, DatabasePropertyConfigResponse>

The updated property schema

PageIconResponse | null

The updated icon

string

ISO 8601 timestamp when the data source was last edited (updated)

PartialUserObjectResponse

The user who last edited the data source

Examples

Update title and icon

import { Client } from "@notionhq/client"

const notion = new Client({ auth: process.env.NOTION_API_KEY })

const updated = await notion.dataSources.update({
  data_source_id: "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  title: [
    {
      type: "text",
      text: { content: "Updated Data Source" }
    }
  ],
  icon: {
    type: "emoji",
    emoji: "🔄"
  }
})

Add a new property

const updated = await notion.dataSources.update({
  data_source_id: "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  properties: {
    "Priority": {
      select: {
        options: [
          { name: "High", color: "red" },
          { name: "Medium", color: "yellow" },
          { name: "Low", color: "green" }
        ]
      }
    }
  }
})

Rename a property

const updated = await notion.dataSources.update({
  data_source_id: "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  properties: {
    "OldName": {
      name: "NewName"
    }
  }
})

Remove a property

const updated = await notion.dataSources.update({
  data_source_id: "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  properties: {
    "PropertyToRemove": null
  }
})

Move to trash

const archived = await notion.dataSources.update({
  data_source_id: "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  in_trash: true
})

dataSources.retrieve - Retrieve a data source by ID
dataSources.create - Create a new data source
dataSources.query - Query pages from a data source

Client

Blocks

Pages

Databases

Data Sources

Users

Comments

File Uploads

Search & OAuth

Helpers

Errors

Method

Parameters

Response

Examples

Update title and icon

Add a new property

Rename a property

Remove a property

Move to trash

​Method

​Parameters

​Response

​Examples

​Update title and icon

​Add a new property

​Rename a property

​Remove a property

​Move to trash

​Related Methods

Method

Parameters

Response

Examples

Update title and icon

Add a new property

Rename a property

Remove a property

Move to trash

Related Methods