Update a block

PATCH

/v1/blocks/{id}

This endpoint allows you to update block content. See Full Documentation

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PATCH '/v1/blocks/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "paragraph": {
        "text": [
            {
                "text": {
                    "content": "hello to you"
                },
                "type": "text"
            }
        ]
    }
}'

Response Example

{
    "created_time": "2021-08-06T17:46:00.000Z",
    "has_children": false,
    "id": "4868767d-9029-4b9d-a41b-652ef4c9c7b9",
    "last_edited_time": "2021-08-12T00:12:00.000Z",
    "object": "block",
    "paragraph": {
        "text": [
            {
                "annotations": {
                    "bold": false,
                    "code": false,
                    "color": "default",
                    "italic": false,
                    "strikethrough": false,
                    "underline": false
                },
                "href": null,
                "plain_text": "hello to you",
                "text": {
                    "content": "hello to you",
                    "link": null
                },
                "type": "text"
            }
        ]
    },
    "type": "paragraph"
}

Request

Path Params

string

required

Body Params application/json

paragraph

object

optional

text

array [object {2}]

optional

Examples

Responses

🟢200200 Success - Update a block

application/json

Body

created_time

string

optional

Example:

2021-08-06T17:46:00.000Z

has_children

boolean

optional

Example:

false

string

optional

Example:

4868767d-9029-4b9d-a41b-652ef4c9c7b9

last_edited_time

string

optional

Example:

2021-08-12T00:12:00.000Z

object

string

optional

Example:

block

paragraph

object

optional

text

array [object {5}]

optional

type

string

optional

Example:

paragraph

Modified at 2023-04-27 10:02:23

Retrieve a block

Retrieve block children