Skip to main content
PATCH
Change a note

Authorizations

Authorization
string
header
required

An API key from the web app (Settings → Developer), sent as Authorization: Bearer rvl_live_….

Path Parameters

noteId
string
required

Note id, note_….

Body

application/json
title
string
Required string length: 1 - 200
content
string

Replaces the whole body. Needs expectedUpdatedAt. Can be empty.

Maximum string length: 90000
append
string

Added to the end of the body; the rest of the note, formatting included, is untouched. Can't be sent with content.

Required string length: 1 - 90000
format
enum<string>
default:markdown

markdown (default) or html. Notes are stored as HTML from the web app's editor. Markdown is converted both ways; it drops colours, font sizes, alignment and merged table cells. HTML is sanitised to what the editor itself produces.

Available options:
markdown,
html
expectedUpdatedAt
string<date-time>

The note's updatedAt when you read it. Required with content; optional otherwise. If the note has changed since (the web app saves as people type), nothing is changed and the answer is 409 CONFLICT: read it again.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$

Response

OK

id
string
required

Note id, note_….

title
string
required
folder
object | null
required

The folder it is in.

project
object | null
required

The project it is linked to, directly or through its folder.

owner
object | null
required

Its author, or for early notes with none, its folder's owner.

access
enum<string>
required

What you can do. owner: everything, including delete and share. write: edit. read: read.

Available options:
owner,
write,
read
createdAt
string<date-time>
required
updatedAt
string<date-time>
required

Send this back as expectedUpdatedAt to replace the body.

format
enum<string>
required
Available options:
markdown,
html
content
string
required

The body, in format. Notes written before the rich editor are plain text in either format.