Skip to content

Replace a Note body

PUT
/api/v1/notes/{id}/body
curl --request PUT \
--url https://example.com/api/v1/notes/example/body \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'If-Match: example' \
--data '{ "body": "example" }'

Requires a signed-in User with edit access to the Note and its current ETag in If-Match. It returns 404 when the Note is missing, 412 when it changed, or 428 when If-Match is missing. Route: /api/v1/notes/{id}/body. Inputs: id, If-Match. Do not automatically replay this operation after an uncertain result.

id
required
string
If-Match
required
string

Current Note ETag

Media typeapplication/json
object
body
required
string
Examplegenerated
{
"body": "example"
}
Media typeapplication/json
object
body
required
string
canvas

Validated render data for Canvas; an invalid imported file has no scene.

etag
required
string
id
required
string
path
required
string
properties
required
title
required
string
Examplegenerated
{
"body": "example",
"canvas": "example",
"etag": "example",
"id": "example",
"path": "example",
"properties": "example",
"title": "example"
}