BrewForge Docs

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`).

POST
/api/v1/actions/delete_taplist_item

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).

AuthorizationBearer <token>

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 brews
  • brews:write: Create, update, delete brews and notes
  • inventory:read: List inventory items
  • inventory:write: Create, update, delete inventory items
  • equipment:read: List equipment profiles
  • equipment:write: Create, update, delete equipment profiles
  • styles:read: List style profiles
  • styles:write: Create, update, delete style profiles
  • profiles:read: List mash, fermentation, and water profiles
  • custom-fields:read: List custom field definitions
  • custom-fields:write: Create, update, delete custom field definitions
  • profiles:write: Create, update, delete mash, fermentation, and water profiles
  • cellar:read: View cellar, packaged stock, tap lists, and labels
  • cellar:write: Manage cellar, packaging, stock, tap lists, and labels
  • settings:read: View preferences, imports, calculators, and your data export
  • settings:write: Change preferences and undo imports
  • community:read: View community, feedback, tickets, inbox, and account overview
  • community:write: Post, vote, and reply in community, feedback, and tickets

In: header

Scope: cellar:write

Request Body

application/json

kind*string

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).

Value in"list" | "beer" | "tap" | "menu" | "screen"
ref*string

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.

list?string

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.

confirm?boolean

Set to true to really do it. Without it nothing changes and the result lists what would be removed.

[key: string]?never

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": {}
  }
}