Add a beer to a tap list, or change it
Adds a beer to a tap list or changes how it is shown. beer = one of the brewer's brews (name, batch number or id): added if it is not on the list yet, otherwise changed; its style, ABV, IBU come from the brew. name without beer = add a beer that is not one of the brewer's brews (a guest beer), with style/abv_pct/... typed in. beer + name = show it under another name. Override fields (style, abv_pct, ...) replace the brew's values on menus; null clears an override. available: false hides it without removing it; position moves it in the list (1 = first). Putting it on a tap is manage_tap; removing it is delete_taplist_item. Needs the plan feature `taplist`. Scope: `cellar:write` (or `write`).
Adds a beer to a tap list or changes how it is shown. beer = one of the brewer's brews (name, batch number or id): added if it is not on the list yet, otherwise changed; its style, ABV, IBU come from the brew. name without beer = add a beer that is not one of the brewer's brews (a guest beer), with style/abv_pct/... typed in. beer + name = show it under another name. Override fields (style, abv_pct, ...) replace the brew's values on menus; null clears an override. available: false hides it without removing it; position moves it in the list (1 = first). Putting it on a tap is manage_tap; removing it is delete_taplist_item.
Needs the plan feature taplist. Scope: cellar: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: cellar:write
Request Body
application/json
The tap list: its id or exact name (e.g. "Taproom"). Optional when the brewer has only one tap list.
A beer on the list (id or shown name) or a brew to add (id, batch number or exact name), e.g. "Oatmeal Stout".
Shown name. Without beer: adds a guest beer of this name, e.g. "Augustiner Helles".
length <= 200Brewer shown, e.g. a guest brewery.
Style shown, e.g. "Helles".
% ABV shown, e.g. 5.2.
IBU shown.
Original gravity (SG, e.g. 1.048).
Final gravity (SG, e.g. 1.010).
Colour in EBC, e.g. 8. Send this or color_srm.
Colour in SRM, e.g. 4 (tap lists store SRM). Send this or color_ebc.
Tasting notes shown on menus.
How it is served, e.g. ["tap"] or ["bottle","can"]. Only "tap" beers can go on a tap.
1 <= items <= 4false hides it from menus/screens (e.g. sold out); true shows it again.
Place in the list, 1 = first.
1 <= valueResponse 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_taplist_beer" \ -H "Content-Type: application/json" \ -d '{}'{
"added": true,
"list": "string",
"beer": {
"id": "string",
"name": "string",
"brew_id": "string",
"style": "string",
"abv_pct": 0,
"ibu": 0,
"color_ebc": 0,
"color_srm": 0,
"serving": [
"string"
],
"available": true,
"on_tap": "string",
"next_up_on": "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": {}
}
}