Skip to main content
PATCH
Update a note

Authorizations

Authorization
string
header
required

A Parley API key.

Path Parameters

id
string
required

The note ID.

Minimum string length: 1

Body

application/json
expectedVersion
integer
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.

Required range: 1 <= x <= 9007199254740991
name
string

A new title.

Required string length: 1 - 255
content
string

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

Response

OK

id
string
required

The note ID.

Minimum string length: 1
name
string
required

The note title.

location
object
required

The project, account, or contact the note is on.

version
integer
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.

Required range: 1 <= x <= 9007199254740991
createdAt
string<date-time>
required

When the note was created.

updatedAt
string<date-time>
required

When the note was last changed, including renames.