Set custom field values on a brew
Fill in the brewer's own custom fields on a brew (fields they defined in settings, e.g. "Water source" or "Hop lot"). values maps field name (or id) to its value, e.g. {"Water source": "tap", "Mash tun loss L": 1.2}; null clears a value. Send values: {} to only list the fields with their type, allowed choices and current values. Defining new fields is not done here. Scope: `brews:write` (or `write`).
Fill in the brewer's own custom fields on a brew (fields they defined in settings, e.g. "Water source" or "Hop lot"). values maps field name (or id) to its value, e.g. {"Water source": "tap", "Mash tun loss L": 1.2}; null clears a value. Send values: {} to only list the fields with their type, allowed choices and current values. Defining new fields is not done here.
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.
Field name or id → value: text/select/date/url as string, number/integer as number, boolean as true/false, null clears. E.g. {"Water source": "tap"}.
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/set_brew_custom_fields" \ -H "Content-Type: application/json" \ -d '{ "brew": "string", "values": { "property1": "string", "property2": "string" } }'{
"brew": {
"id": "string",
"name": "string",
"status": "string",
"batch_number": 0
},
"fields": [
{
"id": "string",
"name": "string",
"type": "string",
"unit": "string",
"choices": [
"string"
],
"placement": "string",
"value": "string"
}
],
"changed": [
"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": {}
}
}