---
title: "Update a data source"
method: PATCH
path: "/v1/data_sources/{data_source_id}"
tags: ["Data sources"]
---

# Update a data source

`PATCH /v1/data_sources/{data_source_id}`

## Path parameters

- `data_source_id` string, required

## Headers

- `Notion-Version` '2026-03-11', required

## Request body

- object
  - `title` RichTextItemRequest[] — Title of data source as it appears in Notion.
    - union
      - object
        - `annotations` AnnotationRequest
          - `bold` boolean — Whether the text is formatted as bold.
          - `italic` boolean — Whether the text is formatted as italic.
          - `strikethrough` boolean — Whether the text is formatted with a strikethrough.
          - `underline` boolean — Whether the text is formatted with an underline.
          - `code` boolean — Whether the text is formatted as code.
          - `color` 'default' | 'gray' | 'brown' | 'orange' | 'yellow' | 'green' | 'blue' | 'purple' | 'pink' | 'red' | 'default_background' | 'gray_background' | 'brown_background' | 'orange_background' | 'yellow_background' | 'green_background' | 'blue_background' | 'purple_background' | 'pink_background' | 'red_background' — One of: `default`, `gray`, `brown`, `orange`, `yellow`, `green`, `blue`, `purple`, `pink`, `red`, `default_background`, `gray_background`, `brown_background`, `orange_background`, `yellow_background`, `green_background`, `blue_background`, `purple_background`, `pink_background`, `red_background`
        - `type` 'text' — Always `text`
        - `text` object, required — If a rich text object's type value is `text`, then the corresponding text field contains an object including the text content and any inline link.
          - `content` string, required — The actual text content of the text.
          - `link` object, nullable — An object with information about any inline link in this text, if included.
            - `url` string, required — The URL of the link.
      - object
        - `annotations` AnnotationRequest
          - `bold` boolean — Whether the text is formatted as bold.
          - `italic` boolean — Whether the text is formatted as italic.
          - `strikethrough` boolean — Whether the text is formatted with a strikethrough.
          - `underline` boolean — Whether the text is formatted with an underline.
          - `code` boolean — Whether the text is formatted as code.
          - `color` 'default' | 'gray' | 'brown' | 'orange' | 'yellow' | 'green' | 'blue' | 'purple' | 'pink' | 'red' | 'default_background' | 'gray_background' | 'brown_background' | 'orange_background' | 'yellow_background' | 'green_background' | 'blue_background' | 'purple_background' | 'pink_background' | 'red_background' — One of: `default`, `gray`, `brown`, `orange`, `yellow`, `green`, `blue`, `purple`, `pink`, `red`, `default_background`, `gray_background`, `brown_background`, `orange_background`, `yellow_background`, `green_background`, `blue_background`, `purple_background`, `pink_background`, `red_background`
        - `type` 'mention' — Always `mention`
        - `mention` union, required — Mention objects represent an inline mention of a database, date, link preview mention, page, template mention, or user. A mention is created in the Notion UI when a user types `@` followed by the name of the reference.
          - object
            - `type` 'user' — Always `user`
            - `user` PartialUserObjectRequest, required
              - …
          - object
            - `type` 'date' — Always `date`
            - `date` DateRequest, required
              - …
          - object
            - `type` 'page' — Always `page`
            - `page` object, required — Details of the page mention.
              - …
          - object
            - `type` 'database' — Always `database`
            - `database` object, required — Details of the database mention.
              - …
          - object
            - `type` 'template_mention' — Always `template_mention`
            - `template_mention` union, required
              - …
          - object
            - `type` 'custom_emoji' — Always `custom_emoji`
            - `custom_emoji` object, required — Details of the custom emoji mention.
              - …
      - object
        - `annotations` AnnotationRequest
          - `bold` boolean — Whether the text is formatted as bold.
          - `italic` boolean — Whether the text is formatted as italic.
          - `strikethrough` boolean — Whether the text is formatted with a strikethrough.
          - `underline` boolean — Whether the text is formatted with an underline.
          - `code` boolean — Whether the text is formatted as code.
          - `color` 'default' | 'gray' | 'brown' | 'orange' | 'yellow' | 'green' | 'blue' | 'purple' | 'pink' | 'red' | 'default_background' | 'gray_background' | 'brown_background' | 'orange_background' | 'yellow_background' | 'green_background' | 'blue_background' | 'purple_background' | 'pink_background' | 'red_background' — One of: `default`, `gray`, `brown`, `orange`, `yellow`, `green`, `blue`, `purple`, `pink`, `red`, `default_background`, `gray_background`, `brown_background`, `orange_background`, `yellow_background`, `green_background`, `blue_background`, `purple_background`, `pink_background`, `red_background`
        - `type` 'equation' — Always `equation`
        - `equation` object, required — Notion supports inline LaTeX equations as rich text objects with a type value of `equation`.
          - `expression` string, required — A KaTeX compatible string.
  - `icon` union
    - FileUploadPageIconRequest
      - `type` 'file_upload' — Always `file_upload`
      - `file_upload` object, required
        - `id` string, required — ID of a FileUpload object that has the status `uploaded`.
    - EmojiPageIconRequest
      - `type` 'emoji' — Always `emoji`
      - `emoji` string, required
    - ExternalPageIconRequest
      - `type` 'external' — Always `external`
      - `external` object, required
        - `url` string, required — The URL of the external file.
    - CustomEmojiPageIconRequest
      - `type` 'custom_emoji' — Always `custom_emoji`
      - `custom_emoji` object, required
        - `id` string, required
        - `name` string — The name of the custom emoji.
        - `url` string — The URL of the custom emoji.
    - IconPageIconRequest
      - `type` 'icon' — Always `icon`
      - `icon` object, required — A Notion native icon, specified by name and optional color.
        - `name` string, required
        - `color` 'gray' | 'lightgray' | 'brown' | 'yellow' | 'orange' | 'green' | 'blue' | 'purple' | 'pink' | 'red' — One of: `gray`, `lightgray`, `brown`, `yellow`, `orange`, `green`, `blue`, `purple`, `pink`, `red`
  - `properties` object — The property schema of the data source. The keys are property names or IDs, and the values are property configuration objects. Properties set to null will be removed.
  - `in_trash` boolean — Whether the data source should be moved to or from the trash. If not provided, the trash status will not be updated.
  - `parent` ParentOfDataSourceRequest
    - `type` 'database_id' — Always `database_id`
    - `database_id` string, required

## Response `200`

- union
  - PartialDataSourceObjectResponse
    - `object` 'data_source', required — The data source object type name.
    - `id` string, uuid, required
    - `properties` object, required — The properties schema of the data source.
  - DataSourceObjectResponse
    - `object` 'data_source', required — The data source object type name.
    - `id` string, uuid, required
    - `title` RichTextItemResponse[], required — The title of the data source.
      - union
        - object
          - `plain_text` string, required — The plain text content of the rich text object, without any styling.
          - `href` string, nullable, required — A URL that the rich text object links to or mentions.
          - `annotations` AnnotationResponse, required
            - `bold` boolean, required
            - `italic` boolean, required
            - `strikethrough` boolean, required
            - `underline` boolean, required
            - `code` boolean, required
            - `color` 'default' | 'gray' | 'brown' | 'orange' | 'yellow' | 'green' | 'blue' | 'purple' | 'pink' | 'red' | 'default_background' | 'gray_background' | 'brown_background' | 'orange_background' | 'yellow_background' | 'green_background' | 'blue_background' | 'purple_background' | 'pink_background' | 'red_background', required — One of: `default`, `gray`, `brown`, `orange`, `yellow`, `green`, `blue`, `purple`, `pink`, `red`, `default_background`, `gray_background`, `brown_background`, `orange_background`, `yellow_background`, `green_background`, `blue_background`, `purple_background`, `pink_background`, `red_background`
          - `type` 'text', required — Always `text`
          - `text` object, required — If a rich text object's type value is `text`, then the corresponding text field contains an object including the text content and any inline link.
            - `content` string, required — The actual text content of the text.
            - `link` object, nullable, required — An object with information about any inline link in this text, if included.
              - …
        - object
          - `plain_text` string, required — The plain text content of the rich text object, without any styling.
          - `href` string, nullable, required — A URL that the rich text object links to or mentions.
          - `annotations` AnnotationResponse, required
            - `bold` boolean, required
            - `italic` boolean, required
            - `strikethrough` boolean, required
            - `underline` boolean, required
            - `code` boolean, required
            - `color` 'default' | 'gray' | 'brown' | 'orange' | 'yellow' | 'green' | 'blue' | 'purple' | 'pink' | 'red' | 'default_background' | 'gray_background' | 'brown_background' | 'orange_background' | 'yellow_background' | 'green_background' | 'blue_background' | 'purple_background' | 'pink_background' | 'red_background', required — One of: `default`, `gray`, `brown`, `orange`, `yellow`, `green`, `blue`, `purple`, `pink`, `red`, `default_background`, `gray_background`, `brown_background`, `orange_background`, `yellow_background`, `green_background`, `blue_background`, `purple_background`, `pink_background`, `red_background`
          - `type` 'mention', required — Always `mention`
          - `mention` union, required — Mention objects represent an inline mention of a database, date, link preview mention, page, template mention, or user. A mention is created in the Notion UI when a user types `@` followed by the name of the reference.
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
        - object
          - `plain_text` string, required — The plain text content of the rich text object, without any styling.
          - `href` string, nullable, required — A URL that the rich text object links to or mentions.
          - `annotations` AnnotationResponse, required
            - `bold` boolean, required
            - `italic` boolean, required
            - `strikethrough` boolean, required
            - `underline` boolean, required
            - `code` boolean, required
            - `color` 'default' | 'gray' | 'brown' | 'orange' | 'yellow' | 'green' | 'blue' | 'purple' | 'pink' | 'red' | 'default_background' | 'gray_background' | 'brown_background' | 'orange_background' | 'yellow_background' | 'green_background' | 'blue_background' | 'purple_background' | 'pink_background' | 'red_background', required — One of: `default`, `gray`, `brown`, `orange`, `yellow`, `green`, `blue`, `purple`, `pink`, `red`, `default_background`, `gray_background`, `brown_background`, `orange_background`, `yellow_background`, `green_background`, `blue_background`, `purple_background`, `pink_background`, `red_background`
          - `type` 'equation', required — Always `equation`
          - `equation` object, required — Notion supports inline LaTeX equations as rich text objects with a type value of `equation`.
            - `expression` string, required — A KaTeX compatible string.
    - `description` RichTextItemResponse[], required — The description of the data source.
      - union
        - object
          - `plain_text` string, required — The plain text content of the rich text object, without any styling.
          - `href` string, nullable, required — A URL that the rich text object links to or mentions.
          - `annotations` AnnotationResponse, required
            - `bold` boolean, required
            - `italic` boolean, required
            - `strikethrough` boolean, required
            - `underline` boolean, required
            - `code` boolean, required
            - `color` 'default' | 'gray' | 'brown' | 'orange' | 'yellow' | 'green' | 'blue' | 'purple' | 'pink' | 'red' | 'default_background' | 'gray_background' | 'brown_background' | 'orange_background' | 'yellow_background' | 'green_background' | 'blue_background' | 'purple_background' | 'pink_background' | 'red_background', required — One of: `default`, `gray`, `brown`, `orange`, `yellow`, `green`, `blue`, `purple`, `pink`, `red`, `default_background`, `gray_background`, `brown_background`, `orange_background`, `yellow_background`, `green_background`, `blue_background`, `purple_background`, `pink_background`, `red_background`
          - `type` 'text', required — Always `text`
          - `text` object, required — If a rich text object's type value is `text`, then the corresponding text field contains an object including the text content and any inline link.
            - `content` string, required — The actual text content of the text.
            - `link` object, nullable, required — An object with information about any inline link in this text, if included.
              - …
        - object
          - `plain_text` string, required — The plain text content of the rich text object, without any styling.
          - `href` string, nullable, required — A URL that the rich text object links to or mentions.
          - `annotations` AnnotationResponse, required
            - `bold` boolean, required
            - `italic` boolean, required
            - `strikethrough` boolean, required
            - `underline` boolean, required
            - `code` boolean, required
            - `color` 'default' | 'gray' | 'brown' | 'orange' | 'yellow' | 'green' | 'blue' | 'purple' | 'pink' | 'red' | 'default_background' | 'gray_background' | 'brown_background' | 'orange_background' | 'yellow_background' | 'green_background' | 'blue_background' | 'purple_background' | 'pink_background' | 'red_background', required — One of: `default`, `gray`, `brown`, `orange`, `yellow`, `green`, `blue`, `purple`, `pink`, `red`, `default_background`, `gray_background`, `brown_background`, `orange_background`, `yellow_background`, `green_background`, `blue_background`, `purple_background`, `pink_background`, `red_background`
          - `type` 'mention', required — Always `mention`
          - `mention` union, required — Mention objects represent an inline mention of a database, date, link preview mention, page, template mention, or user. A mention is created in the Notion UI when a user types `@` followed by the name of the reference.
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
        - object
          - `plain_text` string, required — The plain text content of the rich text object, without any styling.
          - `href` string, nullable, required — A URL that the rich text object links to or mentions.
          - `annotations` AnnotationResponse, required
            - `bold` boolean, required
            - `italic` boolean, required
            - `strikethrough` boolean, required
            - `underline` boolean, required
            - `code` boolean, required
            - `color` 'default' | 'gray' | 'brown' | 'orange' | 'yellow' | 'green' | 'blue' | 'purple' | 'pink' | 'red' | 'default_background' | 'gray_background' | 'brown_background' | 'orange_background' | 'yellow_background' | 'green_background' | 'blue_background' | 'purple_background' | 'pink_background' | 'red_background', required — One of: `default`, `gray`, `brown`, `orange`, `yellow`, `green`, `blue`, `purple`, `pink`, `red`, `default_background`, `gray_background`, `brown_background`, `orange_background`, `yellow_background`, `green_background`, `blue_background`, `purple_background`, `pink_background`, `red_background`
          - `type` 'equation', required — Always `equation`
          - `equation` object, required — Notion supports inline LaTeX equations as rich text objects with a type value of `equation`.
            - `expression` string, required — A KaTeX compatible string.
    - `parent` union, required — The parent of the data source. This is typically a database (`database_id`), but for externally synced data sources, can be another data source (`data_source_id`).
      - DatabaseParentResponse
        - `type` 'database_id', required — The parent type.
        - `database_id` string, uuid, required
      - DataSourceParentResponse
        - `type` 'data_source_id', required — The parent type.
        - `data_source_id` string, uuid, required
        - `database_id` string, uuid, required
    - `database_parent` union, required
      - PageIdParentForBlockBasedObjectResponse
        - `type` 'page_id', required — The parent type.
        - `page_id` string, uuid, required
      - WorkspaceParentForBlockBasedObjectResponse
        - `type` 'workspace', required — The parent type.
        - `workspace` true, required — Always true for workspace parent.
      - DatabaseParentResponse
        - `type` 'database_id', required — The parent type.
        - `database_id` string, uuid, required
      - BlockIdParentForBlockBasedObjectResponse
        - `type` 'block_id', required — The parent type.
        - `block_id` string, uuid, required
    - `is_inline` boolean, required — Whether the data source is inline.
    - `in_trash` boolean, required — Whether the data source is in the trash.
    - `created_time` string, date-time, required — The time when the data source was created.
    - `last_edited_time` string, date-time, required — The time when the data source was last edited.
    - `created_by` PartialUserObjectResponse, required
      - `id` string, uuid, required
      - `object` 'user', required — Always `user`
    - `last_edited_by` PartialUserObjectResponse, required
      - `id` string, uuid, required
      - `object` 'user', required — Always `user`
    - `properties` object, required — The properties schema of the data source.
    - `icon` union, required
      - EmojiPageIconResponse
        - `type` 'emoji', required — Type of icon. In this case, an emoji.
        - `emoji` string, required
      - FilePageIconResponse
        - `type` 'file', required — Type of icon. In this case, a file.
        - `file` InternalFileResponse, required
          - `url` string, required — The URL of the file.
          - `expiry_time` string, date-time, required — The time when the URL will expire.
      - ExternalPageIconResponse
        - `type` 'external', required — Type of icon. In this case, an external URL.
        - `external` object, required — The external URL for the icon.
          - `url` string, required — The URL of the external file or resource.
      - CustomEmojiPageIconResponse
        - `type` 'custom_emoji', required — Type of icon. In this case, a custom emoji.
        - `custom_emoji` CustomEmojiResponse, required
          - `id` string, uuid, required
          - `name` string, required — The name of the custom emoji.
          - `url` string, required — The URL of the custom emoji.
      - IconPageIconResponse
        - `type` 'icon', required — Type of icon. In this case, a Notion native icon.
        - `icon` NoticonIconResponse, required
          - `name` string, required
          - `color` 'gray' | 'lightgray' | 'brown' | 'yellow' | 'orange' | 'green' | 'blue' | 'purple' | 'pink' | 'red', required — One of: `gray`, `lightgray`, `brown`, `yellow`, `orange`, `green`, `blue`, `purple`, `pink`, `red`
    - `cover` union, required
      - FilePageCoverResponse
        - `type` 'file', required — Type of cover. In this case, a file.
        - `file` InternalFileResponse, required
          - `url` string, required — The URL of the file.
          - `expiry_time` string, date-time, required — The time when the URL will expire.
      - ExternalPageCoverResponse
        - `type` 'external', required — Type of cover. In this case, an external URL.
        - `external` object, required — The external URL for the cover.
          - `url` string, required — The URL of the external file or resource.
    - `url` string, required — The URL of the data source.
    - `public_url` string, nullable, required — The public URL of the data source if it is publicly accessible.

## Other responses

- `400`
- `401`
- `403`
- `404`
- `406`
- `409`
- `429`
- `500`
- `503`
- `504`
- `529`

---

[API](https://skmtc.net/notion/apis/notion-api.md) · [All operations](https://skmtc.net/notion/apis/notion-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/notion/notion-api/versions/551da43bb186/schema)
