Sign in

Archive or unarchive a note

Update the archived state of a note

put/notes/{noteId}/archived

Path parameters

noteIdstring required

Note id to update

Request body

archivedboolean required

Set to true to archive the note, false to unarchive it

Response

Ok

reviewState'Verified' | 'Outdated' | 'VerificationRequested' | 'VerificationExpired'
archivedAtstring date-time nullable required

Date of the archiving of the note (null if not archived)

lastEditedAtstring date-time required

Date of the last edition of the note

updatedAtstring date-time required

Date of the last update of the note

createdAtstring date-time required

Date of the creation of the note

columnsstring[]

If note is in a collection, it will contain its column names

attributesstring[]

If note is in a collection, it will contain its attributes ordered by column

urlstring required

Url to the note

listPositionnumber double nullable

Position of the note among its siblings, matching the order shown in the Slite sidebar. Higher values come first (top of the sidebar). By default it is seeded from the creation date, so freshly created docs appear at the top; manual reordering overrides it. Combine with orderBy=listPosition_DESC on the children endpoint to reproduce the sidebar order. Null when the note has no explicit position.

parentNoteIdstring nullable required

Parent note id of the current note. It can be null if it's a root note.

iconColorstring nullable

Optional icon color for the note.

iconShapestring nullable

Optional icon identifier for the note.

titlestring required

Title of the note

idstring required

Id of the note

Changes

Changed in 1 of the 5 revisions of this API.1

  • bf91106381fd1See the full diff
    • ○

      the security scope write was added to the endpoint's security scheme bearer

      api-security-scope-added