BrewForge Docs

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`).

POST
/api/v1/actions/update_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).

AuthorizationBearer <token>

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 brews
  • brews:write: Create, update, delete brews and notes
  • inventory:read: List inventory items
  • inventory:write: Create, update, delete inventory items
  • equipment:read: List equipment profiles
  • equipment:write: Create, update, delete equipment profiles
  • styles:read: List style profiles
  • styles:write: Create, update, delete style profiles
  • profiles:read: List mash, fermentation, and water profiles
  • custom-fields:read: List custom field definitions
  • custom-fields:write: Create, update, delete custom field definitions
  • profiles:write: Create, update, delete mash, fermentation, and water profiles
  • cellar:read: View cellar, packaged stock, tap lists, and labels
  • cellar:write: Manage cellar, packaging, stock, tap lists, and labels
  • settings:read: View preferences, imports, calculators, and your data export
  • settings:write: Change preferences and undo imports
  • community:read: View community, feedback, tickets, inbox, and account overview
  • community:write: Post, vote, and reply in community, feedback, and tickets

In: header

Scope: settings:write

Request Body

application/json

volume_unit?string

Volumes: "liters" or "gallons" (US).

Value in"liters" | "gallons"
weight_unit?string

Weights: "kg" (kg/g) or "lb" (lb/oz).

Value in"kg" | "lb"
temperature_unit?string

Temperatures: "celsius" or "fahrenheit".

Value in"celsius" | "fahrenheit"
gravity_format?string

Gravity: "sg" (1.050) or "plato" (°P).

Value in"sg" | "plato"
color_format?string

Beer color: "srm" or "ebc".

Value in"srm" | "ebc"
pressure_unit?string

Pressure: "psi" or "bar".

Value in"psi" | "bar"
co2_format?string

Carbonation: "volumes" or "gl" (g/L).

Value in"volumes" | "gl"
currency?string

Currency for costs: "EUR" or "USD".

Value in"EUR" | "USD"
date_format?string

Dates: "european" (31.12.2026) or "american" (12/31/2026).

Value in"european" | "american"
ibu_formula?string

IBU formula: "tinseth" or "rager".

Value in"tinseth" | "rager"
efficiency_convention?string

Efficiency: "international" (brewhouse + mash efficiency) or "sudhausausbeute" (German convention).

Value in"international" | "sudhausausbeute"
language?string

App language: "en" or "de".

Value in"en" | "de"
brew_day_recalculation?string

When brew-day measurements differ: "keep_efficiency" (recalculate the targets with the planned efficiency) or "keep_recipe_value" (keep the recipe targets).

Value in"keep_efficiency" | "keep_recipe_value"
brewer_name?|

Brewer or brewery name printed on brew sheets and labels; null clears it.

batch_number_floor?|

The next batch number is at least this (e.g. 100 to continue after an old system); null clears it.

default_equipment_profile?string

Make this own equipment profile the default for new brews (id or exact name, e.g. "Grainfather G30").

default_mash_profile?string

Make this own mash profile the default for new brews (id or exact name, e.g. "Single infusion 67 °C").

default_fermentation_profile?string

Make this own fermentation profile the default for new brews (id or exact name, e.g. "Ale 19 °C").

default_water_profile?string

Make this own water profile the default for new brews (id or exact name, e.g. "Tap water").

default_additions?array<>

Misc ingredients added to every new brew; replaces the whole list, [] clears it.

Itemsitems <= 30
clear_default_bittering_hop?boolean

true: forget the default bittering hop (it is set from the recipe editor's quick bittering).

cacl2_form?|

Form of the calcium chloride used for water salts; null = app default.

cacl2_liquid_concentration_pct?number

Concentration in % when cacl2_form is "liquid", e.g. 33.

Range1 <= value <= 100
calendar_feed?string

"enable": turn the iCal feed on (URL in the result), "regenerate": new secret URL (the old one stops working), "disable": turn it off.

Value in"enable" | "regenerate" | "disable"
calendar_feed_settings?

Which events the iCal feed contains; only the fields you send change.

[key: string]?never

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": {}
  }
}