Change Note properties

PATCH

/api/v1/notes/{id}/properties

curl --request PATCH \
  --url https://example.com/api/v1/notes/example/properties \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'If-Match: example' \
  --data '{ "properties": { "additionalProperty": "example" }, "tags": [ "example" ], "title": "example" }'

Route: /api/v1/notes/{id}/properties. Inputs: id, If-Match. Do not automatically replay this operation after an uncertain result.

Authorizations

• installationBearer
• browserSession

Parameters

Path Parameters

id

required

string

Header Parameters

If-Match

required

string

Current Note ETag

Request Body^required

Media typeapplication/json

Edit Note frontmatter without Task fields or identity changes (#833, DESIGN §9). Null removes a User property. Title changes use the retitle route.

object

properties

Set User properties; null removes a property. Reserved keys are rejected.

object

key

additional properties

string | null

tags

Replace the Note Tags. Omit this field to keep them.

Array<string> | null

title

Retained for compatibility; use retitle to change a Note title.

string | null

Example^generated

{
  "properties": {
    "additionalProperty": "example"
  },
  "tags": [
    "example"
  ],
  "title": "example"
}

Responses

200

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

Example^generated

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

400

Invalid property or title change; use retitle for titles

412

Note changed; read its current ETag before editing

428

If-Match is required