Skip to main content
PATCH
Update report page plan

Authorizations

Authorization
string
header
required

OAuth2 Authorization Code flow

Path Parameters

id
string
required

Page ID (must be a report page)

Body

application/json
status
enum<string>
required
Available options:
pending,
active,
done
goals
object[]
required
current_step
number

Response

Plan updated successfully

object
string
required

Object type

Example:

"page"

id
string
required

Unique identifier

Example:

"p_abc123"

createdAt
string<date-time>
required

Creation timestamp

Example:

"2024-01-15T10:30:00.000Z"

updatedAt
string<date-time>
required

Last update timestamp

Example:

"2024-01-15T14:45:00.000Z"

kind
enum<string>
required

Object kind (report | deal).

Available options:
report,
deal
title
string | null
required

Page title

agent
object
required

Agent reference

assignee
object[]
required

Page assignees. Supports users and agents.

targets
object[]
required

Page targets

permissions
object
required
files
object[]
required
pipelines
object
required

Board placements keyed by pipeline id ({ stage, position }). Empty when not on any board.

properties
object
required

Custom properties (scalar values) keyed by property name. Filter/group via properties.<name>.

relations
object
required

Relation values keyed by relation name (target key or array). Filter via relations.<name>.

summary
string | null
required
createdBy
Created by · object

Principal who created this object

Example:
updatedBy
Updated by · object

Principal who last updated this object

Example:
icon
object | null

Page icon

agentFileId
string | null

Source PPTX file ID for the full deck used by this page agent

content
object

Page-level content. Uses the same schema as block.content and renders before child blocks.

parent
object

Parent relationship (Notion-compatible).

usage
object

Token usage summary for the page

runSessionId
object | null

Associated page run session reference. Use expand=runSessionId.status or expand=runSessionId.userId to include run metadata.

url
string | null

Absolute app URL for the page. Included only when requested with expand=url.