Notion: Blocks schemas
77 Notion schemas with complete fields and constraints.
← Blocks operations · All schemas
Append block children — request body — body position
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | object | Alternative | |
$ (anyOf 1).after_block | object | Required within parent | |
$ (anyOf 1).after_block.id | string | Required within parent | |
$ (anyOf 1).type | string | Required within parent | Must equal: after_block |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2).type | string | Required within parent | Must equal: start |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3).type | string | Required within parent | Must equal: end |
Delete a block — response body — object block
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | Format: uuid |
object | string | Required within parent | Must equal: block |
Delete a block — response body — value
Referenced models: Delete a block — response body — value Audio, Delete a block — response body — value Bookmark, Delete a block — response body — value Breadcrumb, Delete a block — response body — value Bulleted List Item, Delete a block — response body — value Callout, Delete a block — response body — value Child Database, Delete a block — response body — value Child Page, Delete a block — response body — value Code, Delete a block — response body — value Column, Delete a block — response body — value Column List, Delete a block — response body — value Divider, Delete a block — response body — value Embed, Delete a block — response body — value Equation, Delete a block — response body — value File, Delete a block — response body — value Heading 1, Delete a block — response body — value Heading 2, Delete a block — response body — value Heading 3, Delete a block — response body — value Heading 4, Delete a block — response body — value Image, Delete a block — response body — value Link Preview, Delete a block — response body — value Link To Page, Delete a block — response body — value Meeting Notes, Delete a block — response body — value Numbered List Item, Delete a block — response body — value Paragraph, Delete a block — response body — value Pdf, Delete a block — response body — value Quote, Delete a block — response body — value Synced Block, Delete a block — response body — value Tab, Delete a block — response body — value Table, Delete a block — response body — value Table Of Contents, Delete a block — response body — value Table Row, Delete a block — response body — value Template, Delete a block — response body — value To Do, Delete a block — response body — value Toggle, Delete a block — response body — value Unsupported, Delete a block — response body — value Video
Delete a block — response body — value Audio
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
audio | Model | Required within parent | Expand Delete a block — response body — value Pdf pdf |
created_by | Model | Required within parent | Expand Update page — response body — object page created by |
created_time | string | Required within parent | Format: date-time |
has_children | boolean | Required within parent | |
id | string | Required within parent | Format: uuid |
in_trash | boolean | Required within parent | |
last_edited_by | Model | Required within parent | Expand Update page — response body — object page created by |
last_edited_time | string | Required within parent | Format: date-time |
object | string | Required within parent | Must equal: block |
parent | Model | Required within parent | Expand Update page — response body — object page parent |
type | string | Required within parent | Must equal: audio |
Referenced models: Delete a block — response body — value Pdf pdf, Update page — response body — object page parent, Update page — response body — object page created by
Delete a block — response body — value Bookmark
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
bookmark | Model | Required within parent | Expand Delete a block — response body — value Embed embed |
created_by | Model | Required within parent | Expand Update page — response body — object page created by |
created_time | string | Required within parent | Format: date-time |
has_children | boolean | Required within parent | |
id | string | Required within parent | Format: uuid |
in_trash | boolean | Required within parent | |
last_edited_by | Model | Required within parent | Expand Update page — response body — object page created by |
last_edited_time | string | Required within parent | Format: date-time |
object | string | Required within parent | Must equal: block |
parent | Model | Required within parent | Expand Update page — response body — object page parent |
type | string | Required within parent | Must equal: bookmark |
Referenced models: Delete a block — response body — value Embed embed, Update page — response body — object page parent, Update page — response body — object page created by
Delete a block — response body — value Breadcrumb
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
breadcrumb | Model | Required within parent | Expand List views — response body — view |
created_by | Model | Required within parent | Expand Update page — response body — object page created by |
created_time | string | Required within parent | Format: date-time |
has_children | boolean | Required within parent | |
id | string | Required within parent | Format: uuid |
in_trash | boolean | Required within parent | |
last_edited_by | Model | Required within parent | Expand Update page — response body — object page created by |
last_edited_time | string | Required within parent | Format: date-time |
object | string | Required within parent | Must equal: block |
parent | Model | Required within parent | Expand Update page — response body — object page parent |
type | string | Required within parent | Must equal: breadcrumb |
Referenced models: List views — response body — view, Update page — response body — object page parent, Update page — response body — object page created by
Delete a block — response body — value Bulleted List Item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
bulleted_list_item | Model | Required within parent | Expand Delete a block — response body — value Quote quote |
created_by | Model | Required within parent | Expand Update page — response body — object page created by |
created_time | string | Required within parent | Format: date-time |
has_children | boolean | Required within parent | |
id | string | Required within parent | Format: uuid |
in_trash | boolean | Required within parent | |
last_edited_by | Model | Required within parent | Expand Update page — response body — object page created by |
last_edited_time | string | Required within parent | Format: date-time |
object | string | Required within parent | Must equal: block |
parent | Model | Required within parent | Expand Update page — response body — object page parent |
type | string | Required within parent | Must equal: bulleted_list_item |
Referenced models: Delete a block — response body — value Quote quote, Update page — response body — object page parent, Update page — response body — object page created by
Delete a block — response body — value Callout
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
callout | object | Required within parent | |
callout.color | Model | Required within parent | Expand Delete a block — response body — value Quote quote color |
callout.icon | JSON | Required within parent | |
callout.icon (anyOf 1) | Model | Alternative | Expand Get agent — response body — icon value |
callout.icon (anyOf 2) | null | Alternative | |
callout.rich_text | array | Required within parent | Maximum items: 100 |
callout.rich_text[] | Model | Each item | Expand Retrieve a page property item — response body — value Title title |
created_by | Model | Required within parent | Expand Update page — response body — object page created by |
created_time | string | Required within parent | Format: date-time |
has_children | boolean | Required within parent | |
id | string | Required within parent | Format: uuid |
in_trash | boolean | Required within parent | |
last_edited_by | Model | Required within parent | Expand Update page — response body — object page created by |
last_edited_time | string | Required within parent | Format: date-time |
object | string | Required within parent | Must equal: block |
parent | Model | Required within parent | Expand Update page — response body — object page parent |
type | string | Required within parent | Must equal: callout |
Referenced models: Delete a block — response body — value Quote quote color, Get agent — response body — icon value, Update page — response body — object page parent, Update page — response body — object page created by, Retrieve a page property item — response body — value Title title
Delete a block — response body — value Child Database
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
child_database | Model | Required within parent | Expand Delete a block — response body — value Child Page child page |
created_by | Model | Required within parent | Expand Update page — response body — object page created by |
created_time | string | Required within parent | Format: date-time |
has_children | boolean | Required within parent | |
id | string | Required within parent | Format: uuid |
in_trash | boolean | Required within parent | |
last_edited_by | Model | Required within parent | Expand Update page — response body — object page created by |
last_edited_time | string | Required within parent | Format: date-time |
object | string | Required within parent | Must equal: block |
parent | Model | Required within parent | Expand Update page — response body — object page parent |
type | string | Required within parent | Must equal: child_database |
Referenced models: Update page — response body — object page parent, Update page — response body — object page created by, Delete a block — response body — value Child Page child page
Delete a block — response body — value Child Page
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
child_page | Model | Required within parent | Expand Delete a block — response body — value Child Page child page |
created_by | Model | Required within parent | Expand Update page — response body — object page created by |
created_time | string | Required within parent | Format: date-time |
has_children | boolean | Required within parent | |
id | string | Required within parent | Format: uuid |
in_trash | boolean | Required within parent | |
last_edited_by | Model | Required within parent | Expand Update page — response body — object page created by |
last_edited_time | string | Required within parent | Format: date-time |
object | string | Required within parent | Must equal: block |
parent | Model | Required within parent | Expand Update page — response body — object page parent |
type | string | Required within parent | Must equal: child_page |
Referenced models: Update page — response body — object page parent, Update page — response body — object page created by, Delete a block — response body — value Child Page child page
Delete a block — response body — value Child Page child page
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
title | string | Required within parent |
Delete a block — response body — value Code
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
code | object | Required within parent | |
code.caption | array | Required within parent | Maximum items: 100 |
code.caption[] | Model | Each item | Expand Retrieve a page property item — response body — value Title title |
code.language | Model | Required within parent | Expand Delete a block — response body — value Code code language |
code.rich_text | array | Required within parent | Maximum items: 100 |
code.rich_text[] | Model | Each item | Expand Retrieve a page property item — response body — value Title title |
created_by | Model | Required within parent | Expand Update page — response body — object page created by |
created_time | string | Required within parent | Format: date-time |
has_children | boolean | Required within parent | |
id | string | Required within parent | Format: uuid |
in_trash | boolean | Required within parent | |
last_edited_by | Model | Required within parent | Expand Update page — response body — object page created by |
last_edited_time | string | Required within parent | Format: date-time |
object | string | Required within parent | Must equal: block |
parent | Model | Required within parent | Expand Update page — response body — object page parent |
type | string | Required within parent | Must equal: code |
Referenced models: Delete a block — response body — value Code code language, Update page — response body — object page parent, Update page — response body — object page created by, Retrieve a page property item — response body — value Title title
Delete a block — response body — value Code code language
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | string | Root | Known values: abap, abc, agda, arduino, ascii art, assembly, bash, basic, bnf, c, c#, c++, clojure, coffeescript, coq, css, dart, dhall, diff, docker, ebnf, elixir, elm, erlang, f#, flow, fortran, gherkin, glsl, go, graphql, groovy, haskell, hcl, html, idris, java, javascript, json, julia, kotlin, latex, less, lisp, livescript, llvm ir, lua, makefile, markdown, markup, matlab, mathematica, mermaid, nix, notion formula, objective-c, ocaml, pascal, perl, php, plain text, powershell, prolog, protobuf, purescript, python, r, racket, reason, ruby, rust, sass, scala, scheme, scss, shell, smalltalk, solidity, sql, swift, toml, typescript, vb.net, verilog, vhdl, visual basic, webassembly, xml, yaml, java/c/c++/c# |
Delete a block — response body — value Column
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
column | Model | Required within parent | Expand Delete a block — response body — value Column column |
created_by | Model | Required within parent | Expand Update page — response body — object page created by |
created_time | string | Required within parent | Format: date-time |
has_children | boolean | Required within parent | |
id | string | Required within parent | Format: uuid |
in_trash | boolean | Required within parent | |
last_edited_by | Model | Required within parent | Expand Update page — response body — object page created by |
last_edited_time | string | Required within parent | Format: date-time |
object | string | Required within parent | Must equal: block |
parent | Model | Required within parent | Expand Update page — response body — object page parent |
type | string | Required within parent | Must equal: column |
Referenced models: Delete a block — response body — value Column column, Update page — response body — object page parent, Update page — response body — object page created by
Delete a block — response body — value Column List
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
column_list | Model | Required within parent | Expand List views — response body — view |
created_by | Model | Required within parent | Expand Update page — response body — object page created by |
created_time | string | Required within parent | Format: date-time |
has_children | boolean | Required within parent | |
id | string | Required within parent | Format: uuid |
in_trash | boolean | Required within parent | |
last_edited_by | Model | Required within parent | Expand Update page — response body — object page created by |
last_edited_time | string | Required within parent | Format: date-time |
object | string | Required within parent | Must equal: block |
parent | Model | Required within parent | Expand Update page — response body — object page parent |
type | string | Required within parent | Must equal: column_list |
Referenced models: List views — response body — view, Update page — response body — object page parent, Update page — response body — object page created by
Delete a block — response body — value Column column
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
width_ratio | JSON | Optional | |
width_ratio (anyOf 1) | number | Alternative | Ratio between 0 and 1 of the width of this column relative to all columns in the list. If not provided, uses an equal width. |
width_ratio (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Delete a block — response body — value Divider
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_by | Model | Required within parent | Expand Update page — response body — object page created by |
created_time | string | Required within parent | Format: date-time |
divider | Model | Required within parent | Expand List views — response body — view |
has_children | boolean | Required within parent | |
id | string | Required within parent | Format: uuid |
in_trash | boolean | Required within parent | |
last_edited_by | Model | Required within parent | Expand Update page — response body — object page created by |
last_edited_time | string | Required within parent | Format: date-time |
object | string | Required within parent | Must equal: block |
parent | Model | Required within parent | Expand Update page — response body — object page parent |
type | string | Required within parent | Must equal: divider |
Referenced models: List views — response body — view, Update page — response body — object page parent, Update page — response body — object page created by
Delete a block — response body — value Embed
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_by | Model | Required within parent | Expand Update page — response body — object page created by |
created_time | string | Required within parent | Format: date-time |
embed | Model | Required within parent | Expand Delete a block — response body — value Embed embed |
has_children | boolean | Required within parent | |
id | string | Required within parent | Format: uuid |
in_trash | boolean | Required within parent | |
last_edited_by | Model | Required within parent | Expand Update page — response body — object page created by |
last_edited_time | string | Required within parent | Format: date-time |
object | string | Required within parent | Must equal: block |
parent | Model | Required within parent | Expand Update page — response body — object page parent |
type | string | Required within parent | Must equal: embed |
Referenced models: Delete a block — response body — value Embed embed, Update page — response body — object page parent, Update page — response body — object page created by
Delete a block — response body — value Embed embed
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
caption | array | Required within parent | Maximum items: 100 |
caption[] | Model | Each item | Expand Retrieve a page property item — response body — value Title title |
url | string | Required within parent |
Referenced models: Retrieve a page property item — response body — value Title title
Delete a block — response body — value Equation
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_by | Model | Required within parent | Expand Update page — response body — object page created by |
created_time | string | Required within parent | Format: date-time |
equation | Model | Required within parent | Expand Delete a block — response body — value Equation equation |
has_children | boolean | Required within parent | |
id | string | Required within parent | Format: uuid |
in_trash | boolean | Required within parent | |
last_edited_by | Model | Required within parent | Expand Update page — response body — object page created by |
last_edited_time | string | Required within parent | Format: date-time |
object | string | Required within parent | Must equal: block |
parent | Model | Required within parent | Expand Update page — response body — object page parent |
type | string | Required within parent | Must equal: equation |
Referenced models: Delete a block — response body — value Equation equation, Update page — response body — object page parent, Update page — response body — object page created by
Delete a block — response body — value Equation equation
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
expression | string | Required within parent |
Delete a block — response body — value File
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_by | Model | Required within parent | Expand Update page — response body — object page created by |
created_time | string | Required within parent | Format: date-time |
file | Model | Required within parent | Expand Delete a block — response body — value File file |
has_children | boolean | Required within parent | |
id | string | Required within parent | Format: uuid |
in_trash | boolean | Required within parent | |
last_edited_by | Model | Required within parent | Expand Update page — response body — object page created by |
last_edited_time | string | Required within parent | Format: date-time |
object | string | Required within parent | Must equal: block |
parent | Model | Required within parent | Expand Update page — response body — object page parent |
type | string | Required within parent | Must equal: file |
Referenced models: Delete a block — response body — value File file, Update page — response body — object page parent, Update page — response body — object page created by
Delete a block — response body — value File file
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | Model | Alternative | Expand Delete a block — response body — value File file External |
$ (anyOf 2) | Model | Alternative | Expand Delete a block — response body — value File file File |
Referenced models: Delete a block — response body — value File file External, Delete a block — response body — value File file File
Delete a block — response body — value File file External
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
caption | array | Required within parent | Maximum items: 100 |
caption[] | Model | Each item | Expand Retrieve a page property item — response body — value Title title |
external | object | Required within parent | |
external.url | string | Required within parent | Maximum length: 2000 Minimum length: 1 |
name | string | Required within parent | |
type | string | Required within parent | Must equal: external |
Referenced models: Retrieve a page property item — response body — value Title title
Delete a block — response body — value File file File
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
caption | array | Required within parent | Maximum items: 100 |
caption[] | Model | Each item | Expand Retrieve a page property item — response body — value Title title |
file | Model | Required within parent | Expand Get agent — response body — icon value File file |
name | string | Required within parent | |
type | string | Required within parent | Must equal: file |
Referenced models: Get agent — response body — icon value File file, Retrieve a page property item — response body — value Title title
Delete a block — response body — value Heading 1
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_by | Model | Required within parent | Expand Update page — response body — object page created by |
created_time | string | Required within parent | Format: date-time |
has_children | boolean | Required within parent | |
heading_1 | Model | Required within parent | Expand Delete a block — response body — value Heading 1 heading 1 |
id | string | Required within parent | Format: uuid |
in_trash | boolean | Required within parent | |
last_edited_by | Model | Required within parent | Expand Update page — response body — object page created by |
last_edited_time | string | Required within parent | Format: date-time |
object | string | Required within parent | Must equal: block |
parent | Model | Required within parent | Expand Update page — response body — object page parent |
type | string | Required within parent | Must equal: heading_1 |
Referenced models: Delete a block — response body — value Heading 1 heading 1, Update page — response body — object page parent, Update page — response body — object page created by
Delete a block — response body — value Heading 1 heading 1
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
color | Model | Required within parent | Expand Delete a block — response body — value Quote quote color |
is_toggleable | boolean | Required within parent | |
rich_text | array | Required within parent | Maximum items: 100 |
rich_text[] | Model | Each item | Expand Retrieve a page property item — response body — value Title title |
Referenced models: Delete a block — response body — value Quote quote color, Retrieve a page property item — response body — value Title title
Delete a block — response body — value Heading 2
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_by | Model | Required within parent | Expand Update page — response body — object page created by |
created_time | string | Required within parent | Format: date-time |
has_children | boolean | Required within parent | |
heading_2 | Model | Required within parent | Expand Delete a block — response body — value Heading 1 heading 1 |
id | string | Required within parent | Format: uuid |
in_trash | boolean | Required within parent | |
last_edited_by | Model | Required within parent | Expand Update page — response body — object page created by |
last_edited_time | string | Required within parent | Format: date-time |
object | string | Required within parent | Must equal: block |
parent | Model | Required within parent | Expand Update page — response body — object page parent |
type | string | Required within parent | Must equal: heading_2 |
Referenced models: Delete a block — response body — value Heading 1 heading 1, Update page — response body — object page parent, Update page — response body — object page created by
Delete a block — response body — value Heading 3
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_by | Model | Required within parent | Expand Update page — response body — object page created by |
created_time | string | Required within parent | Format: date-time |
has_children | boolean | Required within parent | |
heading_3 | Model | Required within parent | Expand Delete a block — response body — value Heading 1 heading 1 |
id | string | Required within parent | Format: uuid |
in_trash | boolean | Required within parent | |
last_edited_by | Model | Required within parent | Expand Update page — response body — object page created by |
last_edited_time | string | Required within parent | Format: date-time |
object | string | Required within parent | Must equal: block |
parent | Model | Required within parent | Expand Update page — response body — object page parent |
type | string | Required within parent | Must equal: heading_3 |
Referenced models: Delete a block — response body — value Heading 1 heading 1, Update page — response body — object page parent, Update page — response body — object page created by
Delete a block — response body — value Heading 4
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_by | Model | Required within parent | Expand Update page — response body — object page created by |
created_time | string | Required within parent | Format: date-time |
has_children | boolean | Required within parent | |
heading_4 | Model | Required within parent | Expand Delete a block — response body — value Heading 1 heading 1 |
id | string | Required within parent | Format: uuid |
in_trash | boolean | Required within parent | |
last_edited_by | Model | Required within parent | Expand Update page — response body — object page created by |
last_edited_time | string | Required within parent | Format: date-time |
object | string | Required within parent | Must equal: block |
parent | Model | Required within parent | Expand Update page — response body — object page parent |
type | string | Required within parent | Must equal: heading_4 |
Referenced models: Delete a block — response body — value Heading 1 heading 1, Update page — response body — object page parent, Update page — response body — object page created by
Delete a block — response body — value Image
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_by | Model | Required within parent | Expand Update page — response body — object page created by |
created_time | string | Required within parent | Format: date-time |
has_children | boolean | Required within parent | |
id | string | Required within parent | Format: uuid |
image | Model | Required within parent | Expand Delete a block — response body — value Pdf pdf |
in_trash | boolean | Required within parent | |
last_edited_by | Model | Required within parent | Expand Update page — response body — object page created by |
last_edited_time | string | Required within parent | Format: date-time |
object | string | Required within parent | Must equal: block |
parent | Model | Required within parent | Expand Update page — response body — object page parent |
type | string | Required within parent | Must equal: image |
Referenced models: Delete a block — response body — value Pdf pdf, Update page — response body — object page parent, Update page — response body — object page created by
Delete a block — response body — value Link Preview
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_by | Model | Required within parent | Expand Update page — response body — object page created by |
created_time | string | Required within parent | Format: date-time |
has_children | boolean | Required within parent | |
id | string | Required within parent | Format: uuid |
in_trash | boolean | Required within parent | |
last_edited_by | Model | Required within parent | Expand Update page — response body — object page created by |
last_edited_time | string | Required within parent | Format: date-time |
link_preview | Model | Required within parent | Expand Delete a block — response body — value Link Preview link preview |
object | string | Required within parent | Must equal: block |
parent | Model | Required within parent | Expand Update page — response body — object page parent |
type | string | Required within parent | Must equal: link_preview |
Referenced models: Delete a block — response body — value Link Preview link preview, Update page — response body — object page parent, Update page — response body — object page created by
Delete a block — response body — value Link Preview link preview
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
url | string | Required within parent | Maximum length: 2000 Minimum length: 1 |
Delete a block — response body — value Link To Page
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_by | Model | Required within parent | Expand Update page — response body — object page created by |
created_time | string | Required within parent | Format: date-time |
has_children | boolean | Required within parent | |
id | string | Required within parent | Format: uuid |
in_trash | boolean | Required within parent | |
last_edited_by | Model | Required within parent | Expand Update page — response body — object page created by |
last_edited_time | string | Required within parent | Format: date-time |
link_to_page | JSON | Required within parent | |
link_to_page (anyOf 1) | object | Alternative | |
link_to_page (anyOf 1).page_id | string | Required within parent | |
link_to_page (anyOf 1).type | string | Required within parent | Must equal: page_id |
link_to_page (anyOf 2) | object | Alternative | |
link_to_page (anyOf 2).database_id | string | Required within parent | |
link_to_page (anyOf 2).type | string | Required within parent | Must equal: database_id |
link_to_page (anyOf 3) | object | Alternative | |
link_to_page (anyOf 3).comment_id | string | Required within parent | |
link_to_page (anyOf 3).type | string | Required within parent | Must equal: comment_id |
object | string | Required within parent | Must equal: block |
parent | Model | Required within parent | Expand Update page — response body — object page parent |
type | string | Required within parent | Must equal: link_to_page |
Referenced models: Update page — response body — object page parent, Update page — response body — object page created by
Delete a block — response body — value Meeting Notes
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_by | Model | Required within parent | Expand Update page — response body — object page created by |
created_time | string | Required within parent | Format: date-time |
has_children | boolean | Required within parent | |
id | string | Required within parent | Format: uuid |
in_trash | boolean | Required within parent | |
last_edited_by | Model | Required within parent | Expand Update page — response body — object page created by |
last_edited_time | string | Required within parent | Format: date-time |
meeting_notes | Model | Required within parent | Expand Delete a block — response body — value Meeting Notes meeting notes |
object | string | Required within parent | Must equal: block |
parent | Model | Required within parent | Expand Update page — response body — object page parent |
type | string | Required within parent | Must equal: meeting_notes |
Referenced models: Update page — response body — object page parent, Update page — response body — object page created by, Delete a block — response body — value Meeting Notes meeting notes
Delete a block — response body — value Meeting Notes meeting notes
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
calendar_event | Model | Optional | Expand Delete a block — response body — value Meeting Notes meeting notes calendar event |
children | Model | Optional | Expand Delete a block — response body — value Meeting Notes meeting notes children |
is_full_page | boolean | Required within parent | |
recording | Model | Optional | Expand Delete a block — response body — value Meeting Notes meeting notes recording |
status | string | Optional | Known values: transcription_not_started, transcription_paused, transcription_in_progress, transcription_failed, summary_in_progress, notes_ready |
title | array | Optional | Maximum items: 100 |
title[] | Model | Each item | Expand Retrieve a page property item — response body — value Title title |
Referenced models: Retrieve a page property item — response body — value Title title, Delete a block — response body — value Meeting Notes meeting notes calendar event, Delete a block — response body — value Meeting Notes meeting notes children, Delete a block — response body — value Meeting Notes meeting notes recording
Delete a block — response body — value Meeting Notes meeting notes calendar event
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
attendees | array | Optional | Maximum items: 100 |
attendees[] | string | Each item | |
end_time | string | Required within parent | Format: date-time |
event_id | string | Optional | |
start_time | string | Required within parent | Format: date-time |
Delete a block — response body — value Meeting Notes meeting notes children
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
notes_block_id | string | Optional | |
summary_block_id | string | Optional | |
transcript_block_id | string | Optional |
Delete a block — response body — value Meeting Notes meeting notes recording
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
end_time | string | Optional | Format: date-time |
start_time | string | Optional | Format: date-time |
Delete a block — response body — value Numbered List Item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_by | Model | Required within parent | Expand Update page — response body — object page created by |
created_time | string | Required within parent | Format: date-time |
has_children | boolean | Required within parent | |
id | string | Required within parent | Format: uuid |
in_trash | boolean | Required within parent | |
last_edited_by | Model | Required within parent | Expand Update page — response body — object page created by |
last_edited_time | string | Required within parent | Format: date-time |
numbered_list_item | Model | Required within parent | Expand Delete a block — response body — value Numbered List Item numbered list item |
object | string | Required within parent | Must equal: block |
parent | Model | Required within parent | Expand Update page — response body — object page parent |
type | string | Required within parent | Must equal: numbered_list_item |
Referenced models: Delete a block — response body — value Numbered List Item numbered list item, Update page — response body — object page parent, Update page — response body — object page created by
Delete a block — response body — value Numbered List Item numbered list item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
color | Model | Required within parent | Expand Delete a block — response body — value Quote quote color |
list_format | string | Optional | Known values: numbers, letters, roman |
list_start_index | JSON | Optional | |
list_start_index (anyOf 1) | integer | Alternative | Minimum: 1 |
list_start_index (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
rich_text | array | Required within parent | Maximum items: 100 |
rich_text[] | Model | Each item | Expand Retrieve a page property item — response body — value Title title |
Referenced models: Delete a block — response body — value Quote quote color, Retrieve a page property item — response body — value Title title
Delete a block — response body — value Paragraph
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_by | Model | Required within parent | Expand Update page — response body — object page created by |
created_time | string | Required within parent | Format: date-time |
has_children | boolean | Required within parent | |
id | string | Required within parent | Format: uuid |
in_trash | boolean | Required within parent | |
last_edited_by | Model | Required within parent | Expand Update page — response body — object page created by |
last_edited_time | string | Required within parent | Format: date-time |
object | string | Required within parent | Must equal: block |
paragraph | Model | Required within parent | Expand Delete a block — response body — value Paragraph paragraph |
parent | Model | Required within parent | Expand Update page — response body — object page parent |
type | string | Required within parent | Must equal: paragraph |
Referenced models: Delete a block — response body — value Paragraph paragraph, Update page — response body — object page parent, Update page — response body — object page created by
Delete a block — response body — value Paragraph paragraph
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
color | Model | Required within parent | Expand Delete a block — response body — value Quote quote color |
icon | JSON | Required within parent | |
icon (anyOf 1) | Model | Alternative | Expand Get agent — response body — icon value |
icon (anyOf 2) | null | Alternative | |
rich_text | array | Required within parent | Maximum items: 100 |
rich_text[] | Model | Each item | Expand Retrieve a page property item — response body — value Title title |
Referenced models: Delete a block — response body — value Quote quote color, Get agent — response body — icon value, Retrieve a page property item — response body — value Title title
Delete a block — response body — value Pdf
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_by | Model | Required within parent | Expand Update page — response body — object page created by |
created_time | string | Required within parent | Format: date-time |
has_children | boolean | Required within parent | |
id | string | Required within parent | Format: uuid |
in_trash | boolean | Required within parent | |
last_edited_by | Model | Required within parent | Expand Update page — response body — object page created by |
last_edited_time | string | Required within parent | Format: date-time |
object | string | Required within parent | Must equal: block |
parent | Model | Required within parent | Expand Update page — response body — object page parent |
pdf | Model | Required within parent | Expand Delete a block — response body — value Pdf pdf |
type | string | Required within parent | Must equal: pdf |
Referenced models: Delete a block — response body — value Pdf pdf, Update page — response body — object page parent, Update page — response body — object page created by
Delete a block — response body — value Pdf pdf
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | Model | Alternative | Expand Delete a block — response body — value Pdf pdf External |
$ (anyOf 2) | Model | Alternative | Expand Delete a block — response body — value Pdf pdf File |
Referenced models: Delete a block — response body — value Pdf pdf External, Delete a block — response body — value Pdf pdf File
Delete a block — response body — value Pdf pdf External
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
caption | array | Required within parent | Maximum items: 100 |
caption[] | Model | Each item | Expand Retrieve a page property item — response body — value Title title |
external | object | Required within parent | |
external.url | string | Required within parent | Maximum length: 2000 Minimum length: 1 |
type | string | Required within parent | Must equal: external |
Referenced models: Retrieve a page property item — response body — value Title title
Delete a block — response body — value Pdf pdf File
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
caption | array | Required within parent | Maximum items: 100 |
caption[] | Model | Each item | Expand Retrieve a page property item — response body — value Title title |
file | Model | Required within parent | Expand Get agent — response body — icon value File file |
type | string | Required within parent | Must equal: file |
Referenced models: Get agent — response body — icon value File file, Retrieve a page property item — response body — value Title title
Delete a block — response body — value Quote
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_by | Model | Required within parent | Expand Update page — response body — object page created by |
created_time | string | Required within parent | Format: date-time |
has_children | boolean | Required within parent | |
id | string | Required within parent | Format: uuid |
in_trash | boolean | Required within parent | |
last_edited_by | Model | Required within parent | Expand Update page — response body — object page created by |
last_edited_time | string | Required within parent | Format: date-time |
object | string | Required within parent | Must equal: block |
parent | Model | Required within parent | Expand Update page — response body — object page parent |
quote | Model | Required within parent | Expand Delete a block — response body — value Quote quote |
type | string | Required within parent | Must equal: quote |
Referenced models: Delete a block — response body — value Quote quote, Update page — response body — object page parent, Update page — response body — object page created by
Delete a block — response body — value Quote quote
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
color | Model | Required within parent | Expand Delete a block — response body — value Quote quote color |
rich_text | array | Required within parent | Maximum items: 100 |
rich_text[] | Model | Each item | Expand Retrieve a page property item — response body — value Title title |
Referenced models: Delete a block — response body — value Quote quote color, Retrieve a page property item — response body — value Title title
Delete a block — response body — value Quote quote color
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | string | Root | 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` Known values: 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 |
Delete a block — response body — value Synced Block
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_by | Model | Required within parent | Expand Update page — response body — object page created by |
created_time | string | Required within parent | Format: date-time |
has_children | boolean | Required within parent | |
id | string | Required within parent | Format: uuid |
in_trash | boolean | Required within parent | |
last_edited_by | Model | Required within parent | Expand Update page — response body — object page created by |
last_edited_time | string | Required within parent | Format: date-time |
object | string | Required within parent | Must equal: block |
parent | Model | Required within parent | Expand Update page — response body — object page parent |
synced_block | object | Required within parent | |
synced_block.synced_from | JSON | Required within parent | |
synced_block.synced_from (anyOf 1) | object | Alternative | |
synced_block.synced_from (anyOf 1).block_id | string | Required within parent | |
synced_block.synced_from (anyOf 1).type | string | Required within parent | Must equal: block_id |
synced_block.synced_from (anyOf 2) | null | Alternative | |
synced_block.synced_from (anyOf 2).block_id | string | Required within parent | |
synced_block.synced_from (anyOf 2).type | string | Required within parent | Must equal: block_id |
type | string | Required within parent | Must equal: synced_block |
Referenced models: Update page — response body — object page parent, Update page — response body — object page created by
Delete a block — response body — value Tab
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_by | Model | Required within parent | Expand Update page — response body — object page created by |
created_time | string | Required within parent | Format: date-time |
has_children | boolean | Required within parent | |
id | string | Required within parent | Format: uuid |
in_trash | boolean | Required within parent | |
last_edited_by | Model | Required within parent | Expand Update page — response body — object page created by |
last_edited_time | string | Required within parent | Format: date-time |
object | string | Required within parent | Must equal: block |
parent | Model | Required within parent | Expand Update page — response body — object page parent |
tab | Model | Required within parent | Expand List views — response body — view |
type | string | Required within parent | Must equal: tab |
Referenced models: List views — response body — view, Update page — response body — object page parent, Update page — response body — object page created by
Delete a block — response body — value Table
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_by | Model | Required within parent | Expand Update page — response body — object page created by |
created_time | string | Required within parent | Format: date-time |
has_children | boolean | Required within parent | |
id | string | Required within parent | Format: uuid |
in_trash | boolean | Required within parent | |
last_edited_by | Model | Required within parent | Expand Update page — response body — object page created by |
last_edited_time | string | Required within parent | Format: date-time |
object | string | Required within parent | Must equal: block |
parent | Model | Required within parent | Expand Update page — response body — object page parent |
table | Model | Required within parent | Expand Delete a block — response body — value Table table |
type | string | Required within parent | Must equal: table |
Referenced models: Delete a block — response body — value Table table, Update page — response body — object page parent, Update page — response body — object page created by
Delete a block — response body — value Table Of Contents
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_by | Model | Required within parent | Expand Update page — response body — object page created by |
created_time | string | Required within parent | Format: date-time |
has_children | boolean | Required within parent | |
id | string | Required within parent | Format: uuid |
in_trash | boolean | Required within parent | |
last_edited_by | Model | Required within parent | Expand Update page — response body — object page created by |
last_edited_time | string | Required within parent | Format: date-time |
object | string | Required within parent | Must equal: block |
parent | Model | Required within parent | Expand Update page — response body — object page parent |
table_of_contents | object | Required within parent | |
table_of_contents.color | Model | Required within parent | Expand Delete a block — response body — value Quote quote color |
type | string | Required within parent | Must equal: table_of_contents |
Referenced models: Delete a block — response body — value Quote quote color, Update page — response body — object page parent, Update page — response body — object page created by
Delete a block — response body — value Table Row
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_by | Model | Required within parent | Expand Update page — response body — object page created by |
created_time | string | Required within parent | Format: date-time |
has_children | boolean | Required within parent | |
id | string | Required within parent | Format: uuid |
in_trash | boolean | Required within parent | |
last_edited_by | Model | Required within parent | Expand Update page — response body — object page created by |
last_edited_time | string | Required within parent | Format: date-time |
object | string | Required within parent | Must equal: block |
parent | Model | Required within parent | Expand Update page — response body — object page parent |
table_row | Model | Required within parent | Expand Delete a block — response body — value Table Row table row |
type | string | Required within parent | Must equal: table_row |
Referenced models: Delete a block — response body — value Table Row table row, Update page — response body — object page parent, Update page — response body — object page created by
Delete a block — response body — value Table Row table row
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
cells | array | Required within parent | Maximum items: 100 |
cells[] | array | Each item | Maximum items: 100 |
cells[][] | Model | Each item | Expand Retrieve a page property item — response body — value Title title |
Referenced models: Retrieve a page property item — response body — value Title title
Delete a block — response body — value Table table
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
has_column_header | boolean | Required within parent | |
has_row_header | boolean | Required within parent | |
table_width | JSON | Required within parent | |
table_width (anyOf 1) | integer | Alternative | Minimum: 1 |
table_width (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Delete a block — response body — value Template
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_by | Model | Required within parent | Expand Update page — response body — object page created by |
created_time | string | Required within parent | Format: date-time |
has_children | boolean | Required within parent | |
id | string | Required within parent | Format: uuid |
in_trash | boolean | Required within parent | |
last_edited_by | Model | Required within parent | Expand Update page — response body — object page created by |
last_edited_time | string | Required within parent | Format: date-time |
object | string | Required within parent | Must equal: block |
parent | Model | Required within parent | Expand Update page — response body — object page parent |
template | object | Required within parent | |
template.rich_text | array | Required within parent | Maximum items: 100 |
template.rich_text[] | Model | Each item | Expand Retrieve a page property item — response body — value Title title |
type | string | Required within parent | Must equal: template |
Referenced models: Update page — response body — object page parent, Update page — response body — object page created by, Retrieve a page property item — response body — value Title title
Delete a block — response body — value To Do
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_by | Model | Required within parent | Expand Update page — response body — object page created by |
created_time | string | Required within parent | Format: date-time |
has_children | boolean | Required within parent | |
id | string | Required within parent | Format: uuid |
in_trash | boolean | Required within parent | |
last_edited_by | Model | Required within parent | Expand Update page — response body — object page created by |
last_edited_time | string | Required within parent | Format: date-time |
object | string | Required within parent | Must equal: block |
parent | Model | Required within parent | Expand Update page — response body — object page parent |
to_do | object | Required within parent | |
to_do.checked | boolean | Required within parent | |
to_do.color | Model | Required within parent | Expand Delete a block — response body — value Quote quote color |
to_do.rich_text | array | Required within parent | Maximum items: 100 |
to_do.rich_text[] | Model | Each item | Expand Retrieve a page property item — response body — value Title title |
type | string | Required within parent | Must equal: to_do |
Referenced models: Delete a block — response body — value Quote quote color, Update page — response body — object page parent, Update page — response body — object page created by, Retrieve a page property item — response body — value Title title
Delete a block — response body — value Toggle
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_by | Model | Required within parent | Expand Update page — response body — object page created by |
created_time | string | Required within parent | Format: date-time |
has_children | boolean | Required within parent | |
id | string | Required within parent | Format: uuid |
in_trash | boolean | Required within parent | |
last_edited_by | Model | Required within parent | Expand Update page — response body — object page created by |
last_edited_time | string | Required within parent | Format: date-time |
object | string | Required within parent | Must equal: block |
parent | Model | Required within parent | Expand Update page — response body — object page parent |
toggle | Model | Required within parent | Expand Delete a block — response body — value Quote quote |
type | string | Required within parent | Must equal: toggle |
Referenced models: Delete a block — response body — value Quote quote, Update page — response body — object page parent, Update page — response body — object page created by
Delete a block — response body — value Unsupported
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_by | Model | Required within parent | Expand Update page — response body — object page created by |
created_time | string | Required within parent | Format: date-time |
has_children | boolean | Required within parent | |
id | string | Required within parent | Format: uuid |
in_trash | boolean | Required within parent | |
last_edited_by | Model | Required within parent | Expand Update page — response body — object page created by |
last_edited_time | string | Required within parent | Format: date-time |
object | string | Required within parent | Must equal: block |
parent | Model | Required within parent | Expand Update page — response body — object page parent |
type | string | Required within parent | Must equal: unsupported |
unsupported | object | Required within parent | |
unsupported.block_type | string | Required within parent | The underlying block type that is not currently supported by the Public API. Example values include: form, button, drive. |
Referenced models: Update page — response body — object page parent, Update page — response body — object page created by
Delete a block — response body — value Video
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_by | Model | Required within parent | Expand Update page — response body — object page created by |
created_time | string | Required within parent | Format: date-time |
has_children | boolean | Required within parent | |
id | string | Required within parent | Format: uuid |
in_trash | boolean | Required within parent | |
last_edited_by | Model | Required within parent | Expand Update page — response body — object page created by |
last_edited_time | string | Required within parent | Format: date-time |
object | string | Required within parent | Must equal: block |
parent | Model | Required within parent | Expand Update page — response body — object page parent |
type | string | Required within parent | Must equal: video |
video | Model | Required within parent | Expand Delete a block — response body — value Pdf pdf |
Referenced models: Delete a block — response body — value Pdf pdf, Update page — response body — object page parent, Update page — response body — object page created by
Update a block — request body — body value type bookmark bookmark
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
caption | array | Optional | Maximum items: 100 |
caption[] | Model | Each item | Expand Create a database — request body — body title item |
url | string | Optional |
Referenced models: Create a database — request body — body title item
Update a block — request body — body value type code code language
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | string | Root | One of: abap, abc, agda, arduino, ascii art, assembly, bash, basic, bnf, c, c#, c++, clojure, coffeescript, coq, css, dart, dhall, diff, docker, ebnf, elixir, elm, erlang, f#, flow, fortran, gherkin, glsl, go, graphql, groovy, haskell, hcl, html, idris, java, javascript, json, julia, kotlin, latex, less, lisp, livescript, llvm ir, lua, makefile, markdown, markup, matlab, mathematica, mermaid, nix, notion formula, objective-c, ocaml, pascal, perl, php, plain text, powershell, prolog, protobuf, purescript, python, r, racket, reason, ruby, rust, sass, scala, scheme, scss, shell, smalltalk, solidity, sql, swift, toml, typescript, vb.net, verilog, vhdl, visual basic, webassembly, xml, yaml, java/c/c++/c# |
Update a block — request body — body value type embed embed caption, file upload
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
caption | array | Optional | Maximum items: 100 |
caption[] | Model | Each item | Expand Create a database — request body — body title item |
file_upload | Model | Required within parent | Expand Update a block — request body — body value type pdf pdf file upload |
Referenced models: Update a block — request body — body value type pdf pdf file upload, Create a database — request body — body title item
Update a block — request body — body value type equation equation
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
expression | string | Required within parent |
Update a block — request body — body value type file file
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
caption | array | Optional | Maximum items: 100 |
caption[] | Model | Each item | Expand Create a database — request body — body title item |
external | Model | Optional | Expand Update a block — request body — body value type pdf pdf external |
file_upload | Model | Optional | Expand Update a block — request body — body value type pdf pdf file upload |
name | string | Optional | Maximum length: 100 Minimum length: 1 |
Referenced models: Update a block — request body — body value type pdf pdf external, Update a block — request body — body value type pdf pdf file upload, Create a database — request body — body title item
Update a block — request body — body value type heading 1 heading 1
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
color | Model | Optional | Expand Update a block — request body — body value type quote quote color |
is_toggleable | boolean | Optional | |
rich_text | array | Required within parent | Maximum items: 100 |
rich_text[] | Model | Each item | Expand Create a database — request body — body title item |
Referenced models: Update a block — request body — body value type quote quote color, Create a database — request body — body title item
Update a block — request body — body value type paragraph paragraph
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
color | Model | Optional | Expand Update a block — request body — body value type quote quote color |
icon | Model | Optional | Expand Create a database — request body — body icon |
rich_text | array | Optional | Maximum items: 100 |
rich_text[] | Model | Each item | Expand Create a database — request body — body title item |
Referenced models: Update a block — request body — body value type quote quote color, Create a database — request body — body icon, Create a database — request body — body title item
Update a block — request body — body value type pdf pdf
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
caption | array | Optional | Maximum items: 100 |
caption[] | Model | Each item | Expand Create a database — request body — body title item |
external | Model | Optional | Expand Update a block — request body — body value type pdf pdf external |
file_upload | Model | Optional | Expand Update a block — request body — body value type pdf pdf file upload |
Referenced models: Update a block — request body — body value type pdf pdf external, Update a block — request body — body value type pdf pdf file upload, Create a database — request body — body title item
Update a block — request body — body value type pdf pdf external
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
url | string | Required within parent | Maximum length: 2000 Minimum length: 1 |
Update a block — request body — body value type pdf pdf file upload
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
id | string | Required within parent |
Update a block — request body — body value type quote quote
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
color | Model | Optional | Expand Update a block — request body — body value type quote quote color |
rich_text | array | Required within parent | Maximum items: 100 |
rich_text[] | Model | Each item | Expand Create a database — request body — body title item |
Referenced models: Update a block — request body — body value type quote quote color, Create a database — request body — body title item
Update a block — request body — body value type quote quote color
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | string | Root | 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` 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 |
Update a block — request body — body value type tab tab
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
Update a block — request body — body value type table row table row
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
cells | array | Required within parent | Maximum items: 100 |
cells[] | array | Each item | Maximum items: 100 |
cells[][] | Model | Each item | Expand Create a database — request body — body title item |
Referenced models: Create a database — request body — body title item
Update a block — request body — body value type template template
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
rich_text | array | Required within parent | Maximum items: 100 |
rich_text[] | Model | Each item | Expand Create a database — request body — body title item |
Referenced models: Create a database — request body — body title item