Learn about the other types used creating and updating document blocks via the API
The monday.com blocks APIs enable you to create, read, update, and delete document blocks from monday.com docs.
Each object type described below represents a specific part of a document block. You can use these object types to supply metadata in mutations or to define which fields should be returned in your queries.
CreateBlockInput
An object containing the block inputs, by block type.
Field | Description | Supported Field |
---|---|---|
divider_block DividerBlockInput | An object containing the input for creating divider blocks. | block_id String parent_block_id String |
image_block ImageBlockInput | An object containing the input for creating image blocks. | block_id String parent_block_id String public_url String! width Int |
layout_block LayoutBlockInput | An object containing the input for creating layout blocks. | block_id String column_count Int! column_style [ColumnStyleInput!] parent_block_id String |
list_block ListBlockInput | An object containing the input for creating list blocks. | alignment BlockAlignment block_id String delta_format [OperationInput!]! direction BlockDirection indentation Int list_block_type ListBlock parent_block_id String` |
notice_box_block NoticeBoxBlockInput | An object containing the input for creating notice box blocks. | block_id String parent_block_id String theme NoticeBoxTheme! |
page_break_block PageBreakBlockInput | An object containing the input for creating page break blocks. | block_id String parent_block_id String |
table_block TableBlockInput | An object containing the input for creating table blocks. | block_id String column_count Int! column_style [ColumnStyleInput!] parent_block_id String row_count Int! width Int |
text_block TextBlockInput | An object containing the input for creating text blocks. | alignment BlockAlignment block_id String delta_format [OperationInput!]! direction BlockDirection parent_block_id String text_block_type TextBlock |
video_block VideoBlockInput | An object containing the input for creating video blocks. | block_id String parent_block_id String raw_url String! width Int |
DividerBlockInput
An object containing the input for creating divider blocks.
Field | Description |
---|---|
block_id String | The block's unique identifier. |
parent_block_id String | The unique identifier of the parent block to create the new block under. |
ImageBlockInput
An object containing the input for creating image blocks.
Field | Description |
---|---|
block_id String | The block's unique identifier. |
parent_block_id String | The unique identifier of the parent block to create the new block under. |
public_url String! | The image's public URL. |
width Int | The image's width. |
LayoutBlockInput
An object containing the input for creating layout blocks.
Field | Description | Supported Fields |
---|---|---|
block_id String | The block's unique identifier. | |
column_count Int! | The number of columns in the layout. | |
column_style [ColumnStyleInput!] | The column style configuration. | width Int! |
parent_block_id String | The unique identifier of the parent block to create the new block under. |
ColumnStyleInput
An array containing the column style configuration.
Field | Description |
---|---|
width Int! | The column's width percentage. |
Usage and behavior
When a layout is created, the system automatically generates column_count
child cell blocks, one for each column. The layout block itself acts as a container, and each cell has parentBlockId === <layout-block-id>
, making it the direct parent for any content placed in that column. The creation response also includes an ordered list of generated cell IDs under content[0].cells
, represented as a one-dimensional array from left to right.
Recommended workflow
- Create the layout and capture its ID.
- Retrieve the cell block IDs from
content[0].cells
in the response (or by querying the layout block’s children). - Bulk-create child blocks (e.g., textBlock, imageBlock) using
parentBlockId = matrix[row][col]
. UseafterBlockId
only for ordering siblings inside the same cell.
ListBlockInput
An object containing the input for creating list blocks.
Field | Description | Enum Values | Supported Fields |
---|---|---|---|
alignment BlockAlignment | The list block's alignment. | CENTER LEFT RIGHT | |
block_id String | The block's unique identifier. | ||
delta_format [OperationInput!]! | An array of operations specifying the list block's text content and attributes. | attributes AttributesInput insert InsertOpsInput! | |
direction BlockDirection | The list block's text display direction. | LTR RTL | |
indentation Int | The list item's indentation level. | ||
list_block_type TextBlock | The list block type. Default is BULLETED_LIST . | BULLETED_LIST CHECK_LIST NUMBERED_LIST | |
parent_block_id String | The unique identifier of the parent block to create the new block under. |
NoticeBoxBlockInput
An object containing the input for creating notice box blocks. Be sure to capture the notice box block's ID after creation. Every block that will appear inside it must use that as the parent_block_id
.
Field | Description | Enum Values |
---|---|---|
block_id String | The block's unique identifier. | |
parent_block_id String | The unique identifier of the parent block to create the new block under. | |
theme NoticeBoxTheme! | The theme options to apply to the notice box block. | GENERAL INFO TIPS WARNING |
PageBreakBlockInput
An object containing the input for creating page break blocks.
Field | Description |
---|---|
block_id String | The block's unique identifier. |
parent_block_id String | The unique identifier of the parent block to create the new block under. |
TableBlockInput
An object containing the input for creating table blocks.
For simpler table creation, use
add_content_to_doc_from_markdown
with markdown tables instead of manually creating table blocks.
Field | Description | Supported Fields |
---|---|---|
block_id String | The block's unique identifier. | |
column_count Int! | The number of columns in the table. | |
column_style [ColumnStyleInput!] | The column style configuration. | width Int! |
parent_block_id String | The unique identifier of the parent block to create the new block under. | |
row_count Int! | The number of rows in the table. | |
width Int | The table's width. |
Usage and behavior
When a table is created, the system automatically generates a grid of row_count × column_count
child cell blocks (one for each cell). Each cell has parentBlockId === <table-block-id>
and acts as the direct parent for its content. To reference cells, always use the 2D matrix returned under content[0].cells
.
This matrix is row-major (matrix[rowIndex][columnIndex]
). You should not rely on the order returned by docs { blocks { ... } }
since that order is implementation-specific.
Recommended workflow
- Create the table and capture its ID.
- Retrieve
content[0].cells
to get the cell ID matrix. - Bulk-create child blocks (e.g., textBlock, imageBlock) using
parentBlockId = matrix[row][col]
. UseafterBlockId
only for ordering siblings inside the same cell.
TextBlockInput
An object containing the input for creating text blocks.
Field | Description | Enum Values | Supported Fields |
---|---|---|---|
alignment BlockAlignment | The text block's alignment. | CENTER LEFT RIGHT | |
block_id String | The block's unique identifier. | ||
delta_format [OperationInput!]! | An array of operations specifying the text block's content and attributes. | attributes AttributesInput insert InsertOpsInput! | |
direction BlockDirection | The text block's display direction. | LTR RTL | |
parent_block_id String | The unique identifier of the parent block to create the new block under. | ||
text_block_type TextBlock | The text block type. Default is NORMAL_TEXT . | CODE LARGE_TITLE (H1)MEDIUM_TITLE (H2)NORMAL_TEXT (H3)QUOTE SMALL_TITLE |
VideoBlockInput
An object containing the input for creating video blocks.
Field | Description |
---|---|
block_id String | The block's unique identifier. |
parent_block_id String | The unique identifier of the parent block to create the new block under. |
raw_url String! | The video's raw URL. |
width Int | The video's width. |
DocumentBlockV2
An object containing the structured content, hierarchical relationships, and associated metadata of a content block.
Field | Description | Possible Types |
---|---|---|
content [BlockContent]! | A structured array of the block's content. | DividerContent ImageContent LayoutContent ListBlockContent NoticeBoxContent PageBreakContent TableContent TextBlockContent VideoContent |
created_at String | The block's creation date. | |
created_by User | The block's creator. | |
doc_id ID | The unique identifier of the doc the block belongs to. | |
id ID! | The block's unique identifier. | |
parent_block_id String | The unique identifier of the parent block. Null for top-level blocks. | |
position Float | The block's position in the document. Higher numbers indicate placement towards the end of the document. | |
type String | The block's content type. | |
updated_at String | The block's last updated date. |
BlockContent
An abstract union type representing different types of block content. All of the BlockContent
types implement the DocBaseBlockContent
interface. This means they all share the common fields, alignment
and direction
, which can be queried through the interface.
Possible Types | Description |
---|---|
DividerContent | An object containing metadata about a divider block's content. |
ImageContent | An object containing metadata about an image block's content. |
LayoutContent | An object containing metadata about a layout block's content. |
ListBlockContent | An object containing metadata about a list block's content. |
NoticeBoxContent | An object containing metadata about a notice box block's content. |
PageBreakContent | An object containing metadata about a page break block's content. |
TableContent | An object containing metadata about a table block's content. |
TextBlockContent | An object containing metadata about a text block's content. |
VideoContent | An object containing metadata about a video block's content. |
DividerContent
An object containing metadata about a divider block's content.
Field | Description | Enum Values |
---|---|---|
alignment BlockAlignment | The alignment of the block's content. | CENTER LEFT RIGHT |
direction BlockDirection | The text direction of the block's content. | LTR RTL |
ImageContent
An object containing metadata about an image block's content.
Field | Description | Enum Values |
---|---|---|
alignment BlockAlignment | The alignment of the block's content. | CENTER LEFT RIGHT |
direction BlockDirection | The text direction of the block's content. | LTR RTL |
public_url String! | The image's public URL. | |
width Int | The image's width. |
LayoutContent
An object containing metadata about a layout block's content.
Field | Description | Enum Values | Supported Fields |
---|---|---|---|
alignment BlockAlignment | The alignment of the block's content. | CENTER LEFT RIGHT | |
cells [Cell!] | 1-D array of cells. | block_id String! | |
column_style [ColumnStyle!] | The column style configuration. | width Int! | |
direction BlockDirection | The text direction of the block's content. | LTR RTL |
Cell
An object containing metadata about a cell within a layout or table block.
Field | Description |
---|---|
block_id String! | The unique identifier of the block representing the cell (parent block of all the content blocks in the cell). |
ColumnStyle
An object containing the column style configuration.
Field | Description |
---|---|
width Int! | The column's width percentage. |
ListBlockContent
An object containing metadata about a list block's content.
Field | Description | Enum Values | Supported Fields |
---|---|---|---|
alignment BlockAlignment | The alignment of the block's content. | CENTER LEFT RIGHT | |
delta_format [Operation!]! | An array containing the block's text content in delta format. | attributes Attributes insert InsertOps | |
direction BlockDirection | The text direction of the block's content. | LTR RTL | |
indentation Int | The indentation level of the list item. |
NoticeBoxContent
An object containing metadata about a notice box block's content.
Field | Description | Enum Values |
---|---|---|
alignment BlockAlignment | The alignment of the block's content. | CENTER LEFT RIGHT |
direction BlockDirection | The text direction of the block's content. | LTR RTL |
theme NoticeBoxTheme! | The notice box block's theme. | GENERAL INFO TIPS WARNING |
PageBreakContent
An object containing metadata about a page break block's content.
Field | Description | Enum Values |
---|---|---|
alignment BlockAlignment | The alignment of the block's content. | CENTER LEFT RIGHT |
direction BlockDirection | The text direction of the block's content. | LTR RTL |
TableContent
An object containing metadata about a table block's content.
Field | Description | Enum Values | Supported Fields |
---|---|---|---|
alignment BlockAlignment | The alignment of the block's content. | CENTER LEFT RIGHT | |
cells [TableRow!] | 2-D array of cells (rows and columns). | block_id String! | |
column_style [ColumnStyle!] | The column style configuration. | width Int! | |
direction BlockDirection | The text direction of the block's content. | LTR RTL | |
width Int | The table's width. |
ColumnStyle
An object containing the column style configuration.
Field | Description |
---|---|
width Int! | The column's width percentage. |
TableRow
An object containing the table row's configuration.
Field | Description |
---|---|
row_cells [Cell!]! | The row's cells. |
TextBlockContent
An object containing metadata about a text block's content.
Field | Description | Enum Values | Supported Fields |
---|---|---|---|
alignment BlockAlignment | The alignment of the block's content. | CENTER LEFT RIGHT | |
delta_format [Operation!]! | An array containing the block's text content in delta format. | attributes Attributes insert InsertOps | |
direction BlockDirection | The text direction of the block's content. | LTR RTL |
VideoContent
An object containing metadata about a video block's content.
Field | Description | Enum Values |
---|---|---|
alignment BlockAlignment | The alignment of the block's content. | CENTER LEFT RIGHT |
direction BlockDirection | The text direction of the block's content. | LTR RTL |
url String! | The video's raw URL. | |
width Int | The video's width. |
Operation
An array of operations specifying the block's text content and attributes.
Field | Description | Supported Fields |
---|---|---|
attributes Attributes | An object containing the optional text formatting options. | background String bold Boolean code Boolean color String italic Boolean link String strike Boolean underline Boolean |
insert InsertOps | An object containing the content to insert. | blot BlotContent text String |
Attributes
An object containing the optional text formatting options.
Field | Description |
---|---|
background String | The background color (HEX, RGB, or named color). |
bold Boolean | Whether to apply bold formatting to the text. |
code Boolean | Whether to apply code formatting to the text. |
color String | The text's color (HEX, RGB, or named color). |
italic Boolean | Whether to apply italic formatting to the text. |
link String | The URL to create a hyperlink with. |
strike Boolean | Whether to apply strikethrough formatting to the text. |
underline Boolean | Whether to apply underline formatting to the text. |
InsertOps
An object containing the content to insert.
Field | Description | Possible Types |
---|---|---|
blot BlotContent | The structured data within a text block. | DocsColumnValue Mention |
text String | The plain text content. |
DocsColumnValue
An object containing the column value reference for displaying board item column data.
Field | Description |
---|---|
column_id String | The column's unique identifier. |
item_id Int | The item's unique identifier. |
Mention
An object containing the mention metadata for user or document references.
Field | Description | Enum Values |
---|---|---|
id Int | The unique identifier of the mentioned user or document. | |
type DocsMention | The mention's type. | BOARD DOC USER |
OperationInput
An array of operations specifying the block's text content and attributes.
Field | Description | Supported Fields |
---|---|---|
attributes AttributesInput | An object containing the optional text formatting options. | background String bold Boolean code Boolean color String italic Boolean link String strike Boolean underline Boolean |
insert InsertOpsInput! | An object containing the content to insert. | blot BlotInput text String |
AttributesInput
An object containing the optional text formatting options.
Field | Description |
---|---|
background String | The background color (HEX, RGB, or named color). |
bold Boolean | Whether to apply bold formatting to the text. |
code Boolean | Whether to apply code formatting to the text. |
color String | The text's color (HEX, RGB, or named color). |
italic Boolean | Whether to apply italic formatting to the text. |
link String | The URL to create a hyperlink with. |
strike Boolean | Whether to apply strikethrough formatting to the text. |
underline Boolean | Whether to apply underline formatting to the text. |
InsertOpsInput
An object containing the content to insert.
Field | Description | Supported Fields |
---|---|---|
blot BlotInput | The structured data within a text block. | column_value DocsColumnValueInput mention MentionInput |
text String | The plain text content. |
BlotInput
An object containing the structured data within a text block.
Field | Description | Supported Fields |
---|---|---|
column_value DocsColumnValueInput | The column value reference for displaying board item column data. | column_id String! item_id Int! |
mention MentionInput | The mention metadata for user or document references. | id Int! type DocsMention! |
DocsColumnValueInput
An object containing the column value reference for displaying board item column data.
Field | Description |
---|---|
column_id String! | The column's unique identifier. |
item_id Int! | The item's unique identifier. |
MentionInput
An object containing the mention metadata for user or document references.
Field | Description | Enum Values |
---|---|---|
id Int! | The unique identifier of the mentioned user or document. | |
type DocsMention! | The mention's type. | BOARD DOC USER |