Create or edit a tap list
Creates a tap list (the beers on offer somewhere: a taproom, the home bar, an event) or changes its settings. Omit list to create (name required); pass list (id or exact name) to change only the fields given. taps: n creates n taps with the list. Then add beers with save_taplist_beer, put them on taps with manage_tap, and share it with manage_taplist_sharing (a menu or screen link guests open to see the list). Needs the plan feature `taplist`. Scope: `cellar:write` (or `write`).
Creates a tap list (the beers on offer somewhere: a taproom, the home bar, an event) or changes its settings. Omit list to create (name required); pass list (id or exact name) to change only the fields given. taps: n creates n taps with the list. Then add beers with save_taplist_beer, put them on taps with manage_tap, and share it with manage_taplist_sharing (a menu or screen link guests open to see the list).
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
Change this existing tap list (id or exact name). Omit to create a new one.
Name, e.g. "Home bar". Required to create.
1 <= length <= 100Short text shown under the title on menus and screens.
length <= 500How new beers are served by default: tap, bottle, can or growler (default tap).
"tap" | "bottle" | "can" | "growler"true = brews that reach completed are added automatically.
true = also offer brews still conditioning when adding.
Create: also create this many taps, named "Tap 1", "Tap 2", ... (e.g. 4). Add more later with manage_tap action create.
1 <= value <= 40Response 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_tap_list" \ -H "Content-Type: application/json" \ -d '{}'{
"created": true,
"list": {
"id": "string",
"name": "string",
"description": "string",
"default_serving": "string",
"auto_add_completed": true,
"include_conditioning": true
},
"taps": [
"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": {}
}
}