PAparley
Notes

Update a note

Rename a note or replace its content. Pass the version you last read as expectedVersion: if someone changed the note since, this returns 409 VERSION_CONFLICT and changes nothing. Omitted fields are left unchanged.

patch/notes/{id}

Request

  • Base URL
    https://api.parley.so/v1
  • URL
    https://api.parley.so/v1/notes/{id}
  • Auth
    HTTP bearer

Path parameters

idstring required

The note ID.

Request body

expectedVersioninteger required

The note's version when you last read it. Returns 409 if the note changed since then: get it again, reapply your change, and retry with the new version.

namestring

A new title.

contentstring

New markdown that replaces the whole note. Refer to a file with @name and a folder with @name/, and keep existing references exactly as they are.

Response

OK

idstring required

The note ID.

namestring required

The note title.

versioninteger required

Goes up by one each time the content changes or the note is renamed through the API. Pass it as expectedVersion when updating the note.

createdAtstring date-time required

When the note was created.

updatedAtstring date-time required

When the note was last changed, including renames.

Changes

No recorded changes to this operation across all 2 revisions of this API.