Taps: put a beer on, next up, add/rename taps
Works with the taps of a tap list. action: put_on = the beer pours from this tap now; next_up = the beer comes on this tap next; promote = the next-up beer goes on now (keg changed); clear = nothing pours from the tap; clear_next_up; create = new tap (name); rename (name); enable / disable; move (position, 1 = first). Example: "put the porter on tap 2 and make the saison next up" = two calls: {"tap":"Tap 2","action":"put_on","beer":"Porter"} then {"tap":"Tap 2","action":"next_up","beer":"Saison"}. beer is a beer on the list or a brew (added to the list automatically). tap is the tap's name or id ("2" finds "Tap 2"). Returns all taps of the list. Needs the plan feature `taplist`. Scope: `cellar:write` (or `write`).
Works with the taps of a tap list. action: put_on = the beer pours from this tap now; next_up = the beer comes on this tap next; promote = the next-up beer goes on now (keg changed); clear = nothing pours from the tap; clear_next_up; create = new tap (name); rename (name); enable / disable; move (position, 1 = first). Example: "put the porter on tap 2 and make the saison next up" = two calls: {"tap":"Tap 2","action":"put_on","beer":"Porter"} then {"tap":"Tap 2","action":"next_up","beer":"Saison"}. beer is a beer on the list or a brew (added to the list automatically). tap is the tap's name or id ("2" finds "Tap 2"). Returns all taps of 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
The tap list: its id or exact name (e.g. "Taproom"). Optional when the brewer has only one tap list.
put_on, next_up, promote, clear, clear_next_up, create, rename, enable, disable or move.
"put_on" | "next_up" | "promote" | "clear" | "clear_next_up" | "create" | "rename" | "enable" | "disable" | "move"The tap: name or id, e.g. "Tap 2". Not needed for create.
put_on / next_up: the beer (name on the list, or a brew name / batch number), e.g. "Porter".
create / rename: the tap name, e.g. "Tap 3" or "Nitro".
1 <= length <= 100move: new place, 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/manage_tap" \ -H "Content-Type: application/json" \ -d '{ "action": "put_on" }'{
"list": "string",
"tap": "string",
"added_to_list": "string",
"taps": [
{
"id": "string",
"name": "string",
"enabled": true,
"pouring": "string",
"next_up": "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": {}
}
}