v1

latestOpenAPI 3.0.12026-07-268028223.9 KB

Notes

Create a note

Create a new note for a household. Notes use a wrapped body; the required field is note.content: { "note": { "content": "..." } }.

post/v1/households/{household_id}/notes

Headers

Idempotency-Keystring

Unique key to ensure idempotent request handling. If a request with the same key was already processed, the original response will be returned.

Request body

Example request

{
  "note": {
    "content": "Important meeting notes from client discussion"
  }
}

Response

note created

idstring required

The note ID

contentstring required

The plaintext content of the note

pinnedboolean required

Whether the note is pinned

hiddenboolean

Whether the note is hidden

tag_idsstring[] required

The complete set of label IDs applied to the note

book_idstring required

The book ID

household_idstring nullable

The household ID

created_by_idstring nullable

The ID of the user who created the note

created_atstring date-time required

When the note was created

updated_atstring date-time required

When the note was last updated

Example response

{
  "id": "abc123xyz",
  "content": "Meeting notes from client discussion",
  "book_id": "book123xyz",
  "household_id": "household123xyz",
  "created_by_id": "user123xyz"
}