Create or edit an own ingredient
Create an ingredient in My Ingredients (when the catalog does not have it), or edit one of the user's own ingredients. Create: leave out ingredient, send type and name plus any specs. Edit: send ingredient (id or name of an own ingredient; find_ingredients with own_only: true lists them) and only the fields to change; the type comes from the ingredient. Catalog ingredients from packages cannot be edited. Ingredients from an import (e.g. a Brewfather import package) can be moved into My Ingredients with move_to_my_ingredients: true (merges with a matching entry there). Fields by type: fermentable kind, color_ebc, potential_ppg, origin, maltster, non_fermentable, max_usage_pct; hop alpha_acid_pct, beta_acid_pct, purpose, origin, harvest_year, aroma; yeast lab, product_id, kind, form, attenuation_min_pct, attenuation_max_pct, temp_min_c, temp_max_c, flocculation, alcohol_tolerance_pct; misc kind, default_unit. All: description. Send "" to clear a text field. Scope: `inventory:write` (or `write`).
Create an ingredient in My Ingredients (when the catalog does not have it), or edit one of the user's own ingredients. Create: leave out ingredient, send type and name plus any specs. Edit: send ingredient (id or name of an own ingredient; find_ingredients with own_only: true lists them) and only the fields to change; the type comes from the ingredient. Catalog ingredients from packages cannot be edited. Ingredients from an import (e.g. a Brewfather import package) can be moved into My Ingredients with move_to_my_ingredients: true (merges with a matching entry there). Fields by type: fermentable kind, color_ebc, potential_ppg, origin, maltster, non_fermentable, max_usage_pct; hop alpha_acid_pct, beta_acid_pct, purpose, origin, harvest_year, aroma; yeast lab, product_id, kind, form, attenuation_min_pct, attenuation_max_pct, temp_min_c, temp_max_c, flocculation, alcohol_tolerance_pct; misc kind, default_unit. All: description. Send "" to clear a text field.
Scope: inventory: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: inventory:write
Request Body
application/json
Edit this own ingredient (id or exact name, e.g. "Homegrown Cascade"). Leave out to create a new one.
Required to create: fermentable, hop, yeast or misc.
"fermentable" | "hop" | "yeast" | "misc"Name (required to create), e.g. "Homegrown Cascade".
length <= 200Sub-type. Fermentable: grain, sugar, extract, dry_extract, adjunct, fruit (default grain). Yeast: ale, lager, wheat, wine, champagne, brett, kveik. Misc: water_agent, fining, flavor, spice, herb, fruit, nutrient, other.
Fermentable color in EBC (e.g. 3.5 for Pilsner malt).
0 <= value <= 4000Fermentable extract potential in PPG (e.g. 37).
0 <= value <= 50Country of origin (e.g. "Germany").
length <= 100Fermentable maltster/brand.
length <= 200Fermentable that yeast cannot ferment (lactose, maltodextrin).
Fermentable: max share in the grist, %.
0 <= value <= 100Hop alpha acid % (e.g. 7.5).
0 <= value <= 30Hop beta acid %.
0 <= value <= 30Hop purpose: bittering, aroma or dual.
"bittering" | "aroma" | "dual"Hop harvest (crop) year, e.g. 2025.
1900 <= value <= 2100Hop aroma profile.
length <= 1000Yeast lab (e.g. "Fermentis").
length <= 100Yeast product code (e.g. "US-05").
length <= 50Yeast form: dry or liquid.
"dry" | "liquid"Yeast attenuation, low end %.
0 <= value <= 100Yeast attenuation, high end %.
0 <= value <= 100Yeast lowest fermentation temperature, °C.
-5 <= value <= 50Yeast highest fermentation temperature, °C.
-5 <= value <= 50Yeast flocculation.
"low" | "medium" | "high" | "very_high"Yeast alcohol tolerance, % ABV.
0 <= value <= 25Misc: unit it is usually dosed and stocked in.
"g" | "mg" | "ml" | "tsp" | "tbsp" | "each"Free text.
length <= 2000Edit only: move an imported ingredient (from an import package) into My Ingredients. Stock, recipes and orders stay linked.
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_custom_ingredient" \ -H "Content-Type: application/json" \ -d '{}'{
"ingredient": {
"id": "string",
"name": "string",
"type": "fermentable",
"package": "string",
"property1": null,
"property2": null
},
"created": true,
"moved": "moved"
}{
"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": {}
}
}