Skip to content

Create a Note linked to an item

POST
/api/v1/notes/linked-notes
curl --request POST \
--url https://example.com/api/v1/notes/linked-notes \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "path": "example" }'

Requires a signed-in User with the data scope and an item in the User’s Home. It creates a Note in Notes with a link to that item. It returns 400 for an invalid path or title, or 404 when the item is missing. Route: /api/v1/notes/linked-notes. Inputs: . Do not automatically replay this operation after an uncertain result.

Media typeapplication/json
object
path
required
string
Examplegenerated
{
"path": "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"
}