Rename, date, tag or pin a brew
Change a brew's details (not its recipe): name, description, planned brew day, actual brew date, ready-by date, tags, pin. Send only what changes; null clears a date. Setting planned_date on an idea also makes it "planned" (it gets a batch number), which is how you plan a brew for a day. For other status changes use set_brew_status; for ingredients and process use update_recipe. Scope: `brews:write` (or `write`).
Change a brew's details (not its recipe): name, description, planned brew day, actual brew date, ready-by date, tags, pin. Send only what changes; null clears a date. Setting planned_date on an idea also makes it "planned" (it gets a batch number), which is how you plan a brew for a day. For other status changes use set_brew_status; for ingredients and process use update_recipe.
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.
New name, e.g. "Citra Pale Ale v2".
1 <= length <= 200New description; null clears it.
Planned brew day as YYYY-MM-DD (e.g. "2026-11-21"); null clears it. Plans an idea.
Actual brew day (for brews already brewed) (YYYY-MM-DD, e.g. "2026-11-07").
Date the beer must be ready by (YYYY-MM-DD, e.g. "2026-12-24").
What it must be ready for, e.g. "Christmas party"; null clears it.
Replace all tags, e.g. ["hoppy"]. [] removes all.
Tags to add, keeping the others, e.g. ["competition"].
Tags to remove.
Pin (true) or unpin (false) the brew in the sidebar.
Brew type.
"all_grain" | "partial_mash" | "extract"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/update_brew" \ -H "Content-Type: application/json" \ -d '{ "brew": "string" }'{
"brew": {
"id": "string",
"name": "string",
"batch_number": 0,
"status": "idea",
"recipe_id": "string",
"version": "string",
"planned_date": "string",
"brew_date": "string",
"ready_by_date": "string"
},
"tags": [
"string"
],
"pinned": true,
"notes": [
"string"
]
}{
"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": {}
}
}