Skip to content

Notion: Update page

Notion pages.patchPage: arguments, response, policy and SDK examples.

← Pages operations · Get started

Operation notion.patch_page

Provider route: PATCH /v1/pages/{page_id}. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/notion with npm, or alter-sdk-notion with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { NotionIntegration } from "@alter-ai/notion";
async function execute(input: Parameters<NotionIntegration["pages"]["patchPage"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new NotionIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.pages.patchPage(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_notion import NotionIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = NotionIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.pages.patch_page(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.page_idstringRequired within parent
queryobjectOptionalAdditional keys: not allowed
query.filter_propertiesarrayOptionalProperty names or IDs to include in each page’s `properties` object. Other properties are left out. Repeat the parameter to pass more than one value, for example `filter_properties=title&filter_properties=Status`. Pages that aren’t in a data source always return only `title`.
query.filter_properties[]stringEach item
bodyobjectRequired within parentAdditional keys: not allowed
body.coverJSONOptional
body.cover (anyOf 1)ModelAlternativeExpand Create a database — request body — body cover
body.cover (anyOf 2)nullAlternative
body.erase_contentbooleanOptionalWhether to erase all existing content from the page. When used with a template, the template content replaces the existing content. When used without a template, simply clears the page content.
body.iconJSONOptional
body.icon (anyOf 1)ModelAlternativeExpand Create a database — request body — body icon
body.icon (anyOf 2)nullAlternative
body.in_trashbooleanOptional
body.is_archivedbooleanOptional
body.is_lockedbooleanOptionalWhether the page should be locked from editing in the Notion app UI. If not provided, the locked state will not be updated.
body.notificationsModelOptionalExpand Update page — request body — body notifications
body.propertiesModelOptionalExpand Update page — request body — body properties
body.templateJSONOptional
body.template (anyOf 1)objectAlternative
body.template (anyOf 1).timezonestringOptionalIANA timezone to use when resolving template variables like @now and @today (e.g. ‘America/New_York’). Defaults to the authorizing user’s timezone for public integrations, or UTC for internal integrations.
body.template (anyOf 1).typestringRequired within parentMust equal: default
body.template (anyOf 2)objectAlternative
body.template (anyOf 2).template_idstringRequired within parent
body.template (anyOf 2).timezonestringOptionalIANA timezone to use when resolving template variables like @now and @today (e.g. ‘America/New_York’). Defaults to the authorizing user’s timezone for public integrations, or UTC for internal integrations.
body.template (anyOf 2).typestringRequired within parentMust equal: template_id

Referenced models: Create a database — request body — body cover, Create a database — request body — body icon, Update page — request body — body properties, Update page — request body — body notifications

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)ModelAlternativeExpand Update page — response body — object page — page Object Response
$ (anyOf 2)ModelAlternativeExpand Update page — response body — object page — partial Page Object Response

Referenced models: Update page — response body — object page — page Object Response, Update page — response body — object page — partial Page Object Response

112 more schemas are linked from the tables above, on the schema pages.

Update page — response body — object page — page Object Response
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
coverJSONRequired within parentPage cover image.
cover (anyOf 1)ModelAlternativeExpand Update page — response body — object page cover value
cover (anyOf 2)nullAlternative
created_byModelRequired within parentExpand Update page — response body — object page created by
User who created the page.
created_timestringRequired within parentDate and time when this page was created.
Format: date-time
iconJSONRequired within parentPage icon.
icon (anyOf 1)ModelAlternativeExpand Get agent — response body — icon value
icon (anyOf 2)nullAlternative
idstringRequired within parentThe ID of the page.
Format: uuid
in_trashbooleanRequired within parentWhether the page is in trash.
is_archivedbooleanRequired within parentWhether the page has been archived.
is_lockedbooleanRequired within parentWhether the page is locked from editing in the Notion app UI.
last_edited_byModelRequired within parentExpand Update page — response body — object page created by
User who last edited the page.
last_edited_timestringRequired within parentDate and time when this page was last edited.
Format: date-time
objectstringRequired within parentThe page object type name.
Must equal: page
parentModelRequired within parentExpand Update page — response body — object page parent
Information about the page's parent.
propertiesobjectRequired within parentProperty values of this page.
Additional keys: see wildcard field
properties.*ModelAdditional keysExpand Update page — response body — object page properties value
public_urlJSONRequired within parentThe public URL of the Notion page, if it has been published to the web.
public_url (anyOf 1)stringAlternative
public_url (anyOf 2)nullAlternative
urlstringRequired within parentThe URL of the Notion page.

Referenced models: Update page — response body — object page cover value, Get agent — response body — icon value, Update page — response body — object page properties value, Update page — response body — object page parent, Update page — response body — object page created by

Update page — response body — object page — partial Page Object Response
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
idstringRequired within parentThe ID of the page.
Format: uuid
objectstringRequired within parentThe page object type name.
Must equal: page
Create a database — request body — body cover
FieldTypePresenceDescription and constraints
$JSONRoot
$ (oneOf 1)ModelAlternativeExpand Create a database — request body — body cover File Upload
$ (oneOf 2)ModelAlternativeExpand Create a database — request body — body cover External

Referenced models: Create a database — request body — body cover External, Create a database — request body — body cover File Upload

Create a database — request body — body icon
FieldTypePresenceDescription and constraints
$JSONRoot
$ (oneOf 1)ModelAlternativeExpand Create a database — request body — body icon File Upload
$ (oneOf 2)ModelAlternativeExpand Create a database — request body — body icon Emoji
$ (oneOf 3)ModelAlternativeExpand Create a database — request body — body icon External
$ (oneOf 4)ModelAlternativeExpand Create a database — request body — body icon Custom Emoji
$ (oneOf 5)ModelAlternativeExpand Create a database — request body — body icon Icon

Referenced models: Create a database — request body — body icon Custom Emoji, Create a database — request body — body icon Emoji, Create a database — request body — body icon External, Create a database — request body — body icon File Upload, Create a database — request body — body icon Icon

Update page — request body — body notifications
FieldTypePresenceDescription and constraints
$objectRootControls the notifications Notion sends people about this change. Set mode to "silent" to skip page update notifications, @mention notifications, and notifications to people added to a Person property, or "default" to use the standard behavior. Database automations, reminders, and connection webhooks still work as usual. Page history, page activity, and workspace audit logs still record the change.
modestringRequired within parentOne of: default, silent
Update page — response body — object page cover value
FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)ModelAlternativeExpand Update page — response body — object page cover value File
$ (anyOf 2)ModelAlternativeExpand Update page — response body — object page cover value External

Referenced models: Update page — response body — object page cover value External, Update page — response body — object page cover value File

Get agent — response body — icon value
FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)ModelAlternativeExpand Get agent — response body — icon value Emoji
$ (anyOf 2)ModelAlternativeExpand Get agent — response body — icon value File
$ (anyOf 3)ModelAlternativeExpand Get agent — response body — icon value External
$ (anyOf 4)ModelAlternativeExpand Get agent — response body — icon value Custom Emoji
$ (anyOf 5)ModelAlternativeExpand Get agent — response body — icon value Icon

Referenced models: Get agent — response body — icon value Custom Emoji, Get agent — response body — icon value Emoji, Get agent — response body — icon value External, Get agent — response body — icon value File, Get agent — response body — icon value Icon

Update page — response body — object page properties value
FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Update page — response body — object page properties value id
$ (allOf 2)JSONAll variants apply
$ (allOf 2) (anyOf 1)ModelAlternativeExpand Update page — response body — object page properties value value value
$ (allOf 2) (anyOf 2)ModelAlternativeExpand Update page — response body — object page properties value value type rollup

Referenced models: Update page — response body — object page properties value id, Update page — response body — object page properties value value type rollup, Update page — response body — object page properties value value value

Update page — response body — object page created by
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
idstringRequired within parentFormat: uuid
objectstringRequired within parentAlways `user`
Must equal: user

SDK function policy ID: notion.patch_page. Catalog operation: patch_page. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Pinned headers: {"Notion-Version": "2026-03-11"}

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.