BrewForge Docs

Edit a brew's recipe

Change a brew's recipe step by step without resending it: add, change, swap or remove ingredients (by name), set batch volume, boil time, efficiency, mash rests, fermentation stages, style, FG override, or load an equipment/mash/fermentation/water profile by name. target_og / target_ibu rescale malt / bittering hops to hit an OG or IBU (the editor's target modes). Send only what changes. Returns the new planned stats (OG/FG as SG, ABV %, IBU, color EBC), out-of-style warnings, the recipe with entry ids and notes on what changed. Example: swap Cascade for Citra → {"brew": "#12", "change_ingredients": [{"ingredient": "Cascade", "replace_with": "Citra"}]}. Name, dates, tags and status are update_brew / set_brew_status. Imported recipes must be converted first (convert_imported_brew). Scope: `brews:write` (or `write`).

POST
/api/v1/actions/update_recipe

Change a brew's recipe step by step without resending it: add, change, swap or remove ingredients (by name), set batch volume, boil time, efficiency, mash rests, fermentation stages, style, FG override, or load an equipment/mash/fermentation/water profile by name. target_og / target_ibu rescale malt / bittering hops to hit an OG or IBU (the editor's target modes). Send only what changes. Returns the new planned stats (OG/FG as SG, ABV %, IBU, color EBC), out-of-style warnings, the recipe with entry ids and notes on what changed. Example: swap Cascade for Citra → {"brew": "#12", "change_ingredients": [{"ingredient": "Cascade", "replace_with": "Citra"}]}. Name, dates, tags and status are update_brew / set_brew_status. Imported recipes must be converted first (convert_imported_brew).

Scope: brews: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: brews:write

Request Body

application/json

brew*string

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.

add_fermentables?array<>

Fermentables to add (same shape as in create_brew).

add_hops?array<>

Hop additions to add, e.g. [{"name": "Mosaic", "amount_g": 30, "use": "whirlpool", "time_min": 0}].

add_yeasts?array<>

Yeasts to add.

add_miscs?array<>

Other additions to add.

change_ingredients?array<>

Change or swap existing entries, e.g. [{"ingredient": "Cascade", "replace_with": "Citra"}] or [{"ingredient": "Pale Ale Malt", "amount_g": 5500}].

remove_ingredients?array<>

Entries to remove: entry ids or names (a name removes every entry with that name), e.g. ["Crystal 60"].

scale_ingredients?boolean

When batch_volume_l, efficiency_pct or equipment_profile change: true (default) scales the ingredient amounts (malt, hops, yeast, other additions, water) so OG and IBU stay the same, like the app's Scale batch; false only changes the value.

style?string

Beer style: a BJCP 2021 style name or code (e.g. "American IPA", "Hazy IPA", "German Pils" or "21A"), or the name of one of the brewer's own styles. Unknown names fail with similar styles. Send "none" to clear it.

equipment_profile?string

Name or id of one of the brewer's equipment profiles (e.g. "Braumeister 20L"). Sets batch volume, boil time and efficiency from the profile unless you also send them.

mash_profile?string

Name or id of one of the brewer's mash profiles (e.g. "Single infusion 67°C"). Replaces the mash steps.

fermentation_profile?string

Name or id of one of the brewer's fermentation profiles (e.g. "Ale 19°C"). Replaces the fermentation stages.

water_source_profile?string

Name or id of one of the brewer's water profiles (e.g. "Munich tap water"). Used as the recipe's source water.

water_target_profile?string

Name or id of one of the brewer's water profiles (e.g. "Balanced"). Used as the recipe's target water.

batch_volume_l?number

Batch volume in liters (into the fermenter), e.g. 20.

Range0 < value <= 10000
boil_time_min?number

Boil time in minutes, e.g. 60.

Range0 <= value <= 600
efficiency_pct?number

Brewhouse efficiency in %, e.g. 72.

Range1 <= value <= 100
mash_steps?array<>

The full list of mash rests in order; replaces the current steps.

fermentation_stages?array<>

The full list of fermentation stages in order; replaces the current stages.

temp_unit?string

Unit of the temperatures you send: "c" (°C, default) or "f" (°F).

Value in"c" | "f"
fg_override_sg?|

Planned FG to use instead of the one calculated from yeast attenuation, as SG (e.g. 1.012). null removes the override.

target_og?number

OG to hit, as the brew page shows it, in gravity_unit (SG by default, e.g. 1.052; or °P with gravity_unit "plato", e.g. 12.9). Scales the malt amounts and keeps their shares, like the recipe editor's target OG (percentage mode stays on).

target_ibu?number

IBU to hit, as the brew page shows it, e.g. 35. Scales every IBU-giving hop addition (all boil times incl. late ones, first wort, whirlpool; not dry hops) keeping each one's share of the IBU, like the recipe editor's IBU target (stays on). Applied after ingredient changes in the same call.

Range0 <= value <= 200
gravity_unit?string

Unit of the gravity values you send: "sg" (specific gravity, e.g. 1.012; default) or "plato" (°P, e.g. 3.1).

Value in"sg" | "plato"
[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_recipe" \  -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"
  },
  "planned": {
    "og_sg": 0,
    "og_plato": 0,
    "fg_sg": 0,
    "fg_plato": 0,
    "abv_pct": 0,
    "ibu": 0,
    "color_ebc": 0
  },
  "batch_volume_l": 0,
  "equipment": {
    "profile": "string",
    "brewhouse_efficiency_pct": 0,
    "mash_efficiency_pct": 0
  },
  "style_fit": [
    "string"
  ],
  "recipe": {
    "property1": null,
    "property2": null
  },
  "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": {}
  }
}