notes

Update a note

Title and body on editable plain notes; settings (folder_id, append_deadline_hours, alert_email, match_pattern, webhook_url, webhook_secret, webhook_format) on any plain note. Content edits on an append-only note are refused with note_locked; rich notes are refused with content_type_mismatch.

patch/notes/{id}

Request

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

Path parameters

idstring required

Note id (integer) or hashid.

Headers

Idempotency-Keystring

Any unique string per logical write; a replay with the same body returns the first response.

Request body

Response

The updated note.

idinteger required
hashidstring required
filenamestring required
titlestring nullable
format'plain' | 'rich' required
folder_idinteger nullable
pinnedboolean
append_onlyboolean required
client_encryptedboolean required
append_deadline_hoursinteger nullable
alert_emailstring nullable
match_patternstring nullable
match_alerted_atstring date-time nullable
last_appended_atstring date-time nullable
alerted_atstring date-time nullable
webhook_urlstring nullable
webhook_format'generic' | 'slack' | 'discord' | 'google_chat' | 'mattermost' | 'rocket_chat'
webhook_failure_countinteger
webhook_disabled_atstring date-time nullable
created_atstring date-time required
updated_atstring date-time required
plain_bodystring required

The body, or the requested slice of it; for rich notes the plain-text projection.

byte_sizeinteger required

Full body size in bytes, even when sliced.

Changes

No recorded changes to this operation across all 1 revision of this API.