Skip to content

Notion: Update agent status

Notion agents.updateAgentStatus: arguments, response, policy and SDK examples.

← Agents operations · Get started

Operation notion.update_agent_status

Provider route: PATCH /v1/agents/{agent_id}/status. 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["agents"]["updateAgentStatus"]>[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.agents.updateAgentStatus(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.agents.update_agent_status(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.agent_idJSONRequired within parentThe agent ID (a UUID), or `notion_ai` for the personal agent. Endpoint-specific restrictions still apply.
path.agent_id (anyOf 1)stringAlternative
path.agent_id (anyOf 2)stringAlternativeAlways `notion_ai`
Must equal: notion_ai
bodyobjectRequired within parentAdditional keys: not allowed
body.statusstringRequired within parentSet to “active” to re-enable an agent that an editor disabled, through this API or in agent settings, or “disabled” to turn off a running agent.
One of: active, disabled

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

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
agent_idstringRequired within parentFormat: uuid
last_edited_timestringRequired within parentISO 8601 timestamp of when the agent was last edited.
pause_reasonJSONRequired within parentWhy the agent is paused when status is “disabled” (e.g. “disabled_from_api”, “credit_limit”); null when active or deleted.
pause_reason (anyOf 1)stringAlternativeOne of: `run_limit`, `credit_limit`, `runaway_credit_usage`, `workspace_credit_limit`, `owner_allowance_limit`, `failure_limit`, `mark_session_failed_autopause`, `disabled_from_workspace_settings`, `disabled_from_workspace_settings_but_resumable`, `disabled_from_api`, `disabled_from_agent_settings`, `disabled_due_to_no_members_with_access`, `disabled_due_to_lack_of_editors`, `disabled_by_notion`, `internal_error`, `needs_user_review`, `tool_unavailable`
Known values: run_limit, credit_limit, runaway_credit_usage, workspace_credit_limit, owner_allowance_limit, failure_limit, mark_session_failed_autopause, disabled_from_workspace_settings, disabled_from_workspace_settings_but_resumable, disabled_from_api, disabled_from_agent_settings, disabled_due_to_no_members_with_access, disabled_due_to_lack_of_editors, disabled_by_notion, internal_error, needs_user_review, tool_unavailable
pause_reason (anyOf 2)nullAlternative
statusstringRequired within parent”active” when the agent can run; “disabled” when it is paused (see pause_reason); “deleted” when it has been removed.
Known values: active, disabled, deleted

SDK function policy ID: notion.update_agent_status. Catalog operation: update_agent_status. 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.