Metadata that controls how a database property is updated.
Removing a property
To remove a property, the property schema object is null.
"properties": {
"[email protected]": null,
}
"properties": {
"propertyToDelete": null
}
Renaming a property
This updates the name of a property as it appears in Notion.
"properties": {
"[email protected]": {
"name": "New Property Name"
},
}
"properties": {
"Old Property Name": {
"name": "New Property Name
},
}
Property | Type | Description |
---|---|---|
name | string | The name of the property as it appears in Notion. |
Updating property type
To update the property type, the property schema object should contain the key of the type. This type contains behavior of this property. Possible values of this key are "title"
, "rich_text"
, "number"
, "select"
, "multi_select"
, "date"
, "people"
, "files"
, "checkbox"
, "url"
, "email"
, "phone_number"
, "formula"
, "relation"
, "rollup"
, "created_time"
, "created_by"
, "last_edited_time"
, "last_edited_by"
. Within this property, the configuration is a property schema object.
Title properties
Note that the property type of the title cannot be changed.
Select configuration updates
To update an existing select configuration, the property schema object optionally contains the following configuration within the select
property:
Property | Type | Description | Example value |
---|---|---|---|
options | optional array of existing select options and select option objects | Settings for select properties. If an existing option is omitted, it will be removed from the database property. New options will be added to the database property. |
Existing select options
Note that the name and color of an existing option cannot be updated.
Property | Type | Description | Example value |
---|---|---|---|
name | optional string | Name of the option. | "Fruit" |
id | optional string | ID of the option. | "ff8e9269-9579-47f7-8f6e-83a84716863c" |
Multi-select configuration updates
To update an existing select configuration, the property schema object optionally contains the following configuration within the multi_select
property:
Property | Type | Description | Example value |
---|---|---|---|
options | optional array of existing select options and multi-select option objects | Settings for multi select properties. If an existing option is omitted, it will be removed from the database property. New options will be added to the database property. |
Existing multi-select options
Note that the name and color of an existing option cannot be updated.
Property | Type | Description | Example value |
---|---|---|---|
name | string | Name of the option as it appears in Notion. | "Fruit" |
id | optional string | ID of the option. | "ff8e9269-9579-47f7-8f6e-83a84716863c" |