Change preferences
Change the brewer's settings; only what you send changes. Units/formats: e.g. {"volume_unit": "gallons", "temperature_unit": "fahrenheit", "gravity_format": "sg"}. Defaults for new brews: default_equipment_profile / _mash_ / _fermentation_ / _water_profile (own profile by name), brewer_name, batch_number_floor, default_additions (replaces the list). Calendar: calendar_feed "enable" (returns the iCal URL), "regenerate" (new URL, old one stops working) or "disable", and calendar_feed_settings. Returns all preferences like get_preferences. To go back to the default units use reset_preferences. Scope: `settings:write` (or `write`).
Change the brewer's settings; only what you send changes. Units/formats: e.g. {"volume_unit": "gallons", "temperature_unit": "fahrenheit", "gravity_format": "sg"}. Defaults for new brews: default_equipment_profile / mash / fermentation / _water_profile (own profile by name), brewer_name, batch_number_floor, default_additions (replaces the list). Calendar: calendar_feed "enable" (returns the iCal URL), "regenerate" (new URL, old one stops working) or "disable", and calendar_feed_settings. Returns all preferences like get_preferences. To go back to the default units use reset_preferences.
Scope: settings: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: settings:write
Request Body
application/json
Volumes: "liters" or "gallons" (US).
"liters" | "gallons"Weights: "kg" (kg/g) or "lb" (lb/oz).
"kg" | "lb"Temperatures: "celsius" or "fahrenheit".
"celsius" | "fahrenheit"Gravity: "sg" (1.050) or "plato" (°P).
"sg" | "plato"Beer color: "srm" or "ebc".
"srm" | "ebc"Pressure: "psi" or "bar".
"psi" | "bar"Carbonation: "volumes" or "gl" (g/L).
"volumes" | "gl"Currency for costs: "EUR" or "USD".
"EUR" | "USD"Dates: "european" (31.12.2026) or "american" (12/31/2026).
"european" | "american"IBU formula: "tinseth" or "rager".
"tinseth" | "rager"Efficiency: "international" (brewhouse + mash efficiency) or "sudhausausbeute" (German convention).
"international" | "sudhausausbeute"App language: "en" or "de".
"en" | "de"When brew-day measurements differ: "keep_efficiency" (recalculate the targets with the planned efficiency) or "keep_recipe_value" (keep the recipe targets).
"keep_efficiency" | "keep_recipe_value"Brewer or brewery name printed on brew sheets and labels; null clears it.
The next batch number is at least this (e.g. 100 to continue after an old system); null clears it.
Make this own equipment profile the default for new brews (id or exact name, e.g. "Grainfather G30").
Make this own mash profile the default for new brews (id or exact name, e.g. "Single infusion 67 °C").
Make this own fermentation profile the default for new brews (id or exact name, e.g. "Ale 19 °C").
Make this own water profile the default for new brews (id or exact name, e.g. "Tap water").
Misc ingredients added to every new brew; replaces the whole list, [] clears it.
items <= 30true: forget the default bittering hop (it is set from the recipe editor's quick bittering).
Form of the calcium chloride used for water salts; null = app default.
Concentration in % when cacl2_form is "liquid", e.g. 33.
1 <= value <= 100"enable": turn the iCal feed on (URL in the result), "regenerate": new secret URL (the old one stops working), "disable": turn it off.
"enable" | "regenerate" | "disable"Which events the iCal feed contains; only the fields you send change.
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_preferences" \ -H "Content-Type: application/json" \ -d '{}'{}{
"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": {}
}
}