FOfocusbear
note

Create or update a note

Creates a note when no id is given, otherwise updates it. A request with is_brain_dump=true that does not resolve to an existing note updates the user's existing brain dump instead of creating a second one; setting is_brain_dump=true on a different existing note is rejected with 409 while a brain dump exists. pinned=true/false pins or unpins the note (pinned_at is set by the server); a request that only pins leaves updated_at unchanged.

put/note

Request

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

Request body

titlestring
bodystring
idstring uuid
completed_activity_idstring uuid
embedded_todo_idsstring[]
is_brain_dumpboolean

Marks the user's single brain-dump note. An upsert with is_brain_dump=true and no (known) id updates the existing brain dump rather than creating another one.

pinnedboolean

True pins the note to the top of the owner's list, false unpins it. The timestamp is the server's: clients never send pinned_at, and pinning a note that is already pinned keeps its original time.

folder_idstring uuid nullable

Files the note in one of the owner's folders; null takes it out of its folder. Omitted leaves it where it is. Read on a create and on a request that only files (or pins) the note, which is not an edit to it; an edit's folder_id is ignored, since a client saving the whole note it fetched may send a stale one.

Response

idstring required
titlestring required
bodystring
completed_activity_idstring
embedded_todo_idsstring[]
is_brain_dumpboolean required
pinned_atstring date-time nullable required

When the note was pinned; null when it isn't.

folder_idstring nullable required

The folder the note is filed in; null when it is in none.

activity_namestring
activity_emojistring
logged_atstring
created_atstring required
updated_atstring required

Changes

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