Skip to main content
PATCH
/
block_documents
/
{id}
Update Block Document Data
curl --request PATCH \
  --url https://api.example.com/block_documents/{id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "block_schema_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "data": {},
  "merge_existing_data": true
}
'
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.prefect.io/llms.txt

Use this file to discover all available pages before exploring further.

Headers

​
x-prefect-api-version
string

Path Parameters

​
id
string<uuid>
required

The block document id

Body

application/json

Data used by the Prefect REST API to update a block document.

​
block_schema_id
string<uuid> | null

A block schema ID

​
data
Data · object

The block document's data

​
merge_existing_data
boolean
default:true

Response

Successful Response