Add or edit a brew note
Add a timestamped note to a brew's log (what happened, a problem, an adjustment, a tasting impression, a reminder), or edit one. To add, send brew and text (type defaults to "note", time to now). To edit, also send note_id (from list_brew_notes) and only the fields to change. Measurements belong in record_brew_measurements or log_fermentation_reading, not in notes. Scope: `brews:write` (or `write`).
Add a timestamped note to a brew's log (what happened, a problem, an adjustment, a tasting impression, a reminder), or edit one. To add, send brew and text (type defaults to "note", time to now). To edit, also send note_id (from list_brew_notes) and only the fields to change. Measurements belong in record_brew_measurements or log_fermentation_reading, not in notes.
Scope: brews:write (or write).
API token in format: bfk_. Each operation lists the token scope it requires (the scopes are listed below).
read: Read everything (all areas)write: Create, change and delete everything (all areas)brews:read: List and view brewsbrews:write: Create, update, delete brews and notesinventory:read: List inventory itemsinventory:write: Create, update, delete inventory itemsequipment:read: List equipment profilesequipment:write: Create, update, delete equipment profilesstyles:read: List style profilesstyles:write: Create, update, delete style profilesprofiles:read: List mash, fermentation, and water profilescustom-fields:read: List custom field definitionscustom-fields:write: Create, update, delete custom field definitionsprofiles:write: Create, update, delete mash, fermentation, and water profilescellar:read: View cellar, packaged stock, tap lists, and labelscellar:write: Manage cellar, packaging, stock, tap lists, and labelssettings:read: View preferences, imports, calculators, and your data exportsettings:write: Change preferences and undo importscommunity:read: View community, feedback, tickets, inbox, and account overviewcommunity:write: Post, vote, and reply in community, feedback, and tickets
In: header
Scope: brews:write
Request Body
application/json
The brew: its id, its batch number (e.g. 12 or "#12") or its exact name (e.g. "Citra Pale Ale"). Case does not matter.
The note, e.g. "Mash pH came in low, added 2 g chalk". Required when adding.
1 <= length <= 5000"note" (default), "observation", "issue" (something went wrong), "adjustment" (a change you made) or "reminder".
"note" | "observation" | "issue" | "adjustment" | "reminder"Brewing phase it belongs to, e.g. "mash" or "fermentation". Optional.
"planning" | "mash" | "boil" | "fermentation" | "conditioning" | "packaging"When it happened, ISO 8601 with time zone, e.g. 2026-11-11T10:15:00+01:00. Default: now.
date-timeId of an existing note to edit instead of adding a new one.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://brewforge.sh/api/v1/actions/save_brew_note" \ -H "Content-Type: application/json" \ -d '{ "brew": "string" }'{
"brew": {
"id": "string",
"name": "string",
"status": "string",
"batch_number": 0
},
"note": {
"id": "string",
"at": "string",
"type": "note",
"phase": "planning",
"text": "string"
},
"notes_count": 0
}{
"error": {
"code": "string",
"message": "string",
"hint": "string",
"candidates": [
{
"id": "string",
"name": "string"
}
],
"fields": {
"property1": [
"string"
],
"property2": [
"string"
]
},
"details": {}
}
}{
"error": {
"code": "string",
"message": "string",
"hint": "string",
"candidates": [
{
"id": "string",
"name": "string"
}
],
"fields": {
"property1": [
"string"
],
"property2": [
"string"
]
},
"details": {}
}
}{
"error": {
"code": "string",
"message": "string",
"hint": "string",
"candidates": [
{
"id": "string",
"name": "string"
}
],
"fields": {
"property1": [
"string"
],
"property2": [
"string"
]
},
"details": {}
}
}{
"error": {
"code": "string",
"message": "string",
"hint": "string",
"candidates": [
{
"id": "string",
"name": "string"
}
],
"fields": {
"property1": [
"string"
],
"property2": [
"string"
]
},
"details": {}
}
}{
"error": {
"code": "string",
"message": "string",
"hint": "string",
"candidates": [
{
"id": "string",
"name": "string"
}
],
"fields": {
"property1": [
"string"
],
"property2": [
"string"
]
},
"details": {}
}
}{
"error": {
"code": "string",
"message": "string",
"hint": "string",
"candidates": [
{
"id": "string",
"name": "string"
}
],
"fields": {
"property1": [
"string"
],
"property2": [
"string"
]
},
"details": {}
}
}