FOfocusbear
project-notes

Update a shared note (title, content, tags, archived and/or pinned) — any accepted project member, admin or owner

pinned pins or unpins the note for the caller only; pinned_at in responses is the caller's own pin.

patch/projects/{project_id}/notes/{note_id}

Request

  • Base URL
    https://api.focusbear.io (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Path parameters

project_idstring uuid required
note_idstring uuid required

Request body

titlestring
contentobject

TipTap/ProseMirror document JSON snapshot from the editor's autosave.

archivedboolean

True archives the note, false restores it. The timestamp stays server-authoritative — clients never send archived_at.

pinnedboolean

True pins the note for the caller, false unpins it. Pins are per user, so this never reorders a teammate's list, and the timestamp is the server's — clients never send pinned_at.

is_privateboolean

True makes the note visible only to its author, false shares it with the project again. Only the author may change it; sending the note's current value is a no-op anyone can make.

Response

idstring required
project_idstring required
created_bystring
titlestring required
contentobject nullable

TipTap/ProseMirror document JSON. Present on single-note responses; omitted from list responses (which only return metadata).

is_privateboolean required

True when only the author (created_by) can see the note. Only the author may change it.

archived_atstring date-time nullable

Set while the note is archived (filed away, still readable); null when active.

pinned_atstring date-time nullable

When the requesting user pinned the note; null when they haven't. Pins are per user.

created_atstring
updated_atstring

Changes

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