CreateDocBlock
Adds a new content block to a document associated with a workspace.
Input
Name | Type | Required | Description |
DocId | String | True | The unique identifier for the document being referenced or modified. It is used to associate the operation with a specific document in the database. |
AfterBlockId | String | False | The identifier for the block that the new block should follow in the document. If this is not provided, the new block will be inserted at the beginning of the document. |
ParentBlockId | String | False | The identifier for the parent block under which the new block should be appended. This helps structure the document's hierarchical content. |
Type | String | True | The content type of the block being inserted, which defines the nature or format of the data (for example, text, image, table).
The allowed values are board, bulleted_list, check_list, code, divider, image, large_title, layout, medium_title, normal_text, notice_box, numbered_list, quote, small_title, table, video, widget. |
Content | String | True | The actual content of the block being inserted into the document. This could be text, data, or other relevant content specific to the block type. |
Result Set Columns
Name | Type | Description |
Success | Boolean | A boolean flag indicating the result of the operation. A value of true signifies that the operation was completed successfully, while false indicates that an error occurred. |
Details | String | Provides additional information or context about the operation's outcome, such as warnings, partial successes, or specific issues encountered during execution. |
DocumentBlockId | String | The unique identifier assigned to the new block created within the document. This ID is used for future references and modifications to the block. |