Delete a tap list, beer, tap, menu or screen
Removes something from the tap lists: a whole list (with its beers, taps, guest add-links and the list's public menu/screen links; the menu/screen designs themselves stay), a beer from a list (it also leaves its tap), a tap, or a menu/screen design (its public URLs stop working). To hide a sold-out beer without removing it, use save_taplist_beer with available: false; to take a beer off a tap, manage_tap action clear. Without confirm: true it only shows what would be deleted. Destructive: without `confirm: true` nothing changes and the response is `{ needs_confirmation: true, would_delete, message }`. Needs the plan feature `taplist`. Scope: `cellar:write` (or `write`).
Removes something from the tap lists: a whole list (with its beers, taps, guest add-links and the list's public menu/screen links; the menu/screen designs themselves stay), a beer from a list (it also leaves its tap), a tap, or a menu/screen design (its public URLs stop working). To hide a sold-out beer without removing it, use save_taplist_beer with available: false; to take a beer off a tap, manage_tap action clear. Without confirm: true it only shows what would be deleted.
Destructive: without confirm: true nothing changes and the response is { needs_confirmation: true, would_delete, message }. 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
list = a whole tap list; beer = a beer on a list; tap = a tap of a list; menu / screen = a design (taken off every list).
"list" | "beer" | "tap" | "menu" | "screen"What to delete: its id or name (a beer also by its brew name), e.g. "Tap 4" or "Guest Pils". For kind list: the list.
For beer and tap: the list it is on. The tap list: its id or exact name (e.g. "Taproom"). Optional when the brewer has only one tap list.
Set to true to really do it. Without it nothing changes and the result lists what would be removed.
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/delete_taplist_item" \ -H "Content-Type: application/json" \ -d '{ "kind": "list", "ref": "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": {}
}
}