BrewForge Docs

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

POST
/api/v1/actions/save_taplist_beer

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

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

list?string

The tap list: its id or exact name (e.g. "Taproom"). Optional when the brewer has only one tap list.

beer?string

A beer on the list (id or shown name) or a brew to add (id, batch number or exact name), e.g. "Oatmeal Stout".

name?string

Shown name. Without beer: adds a guest beer of this name, e.g. "Augustiner Helles".

Lengthlength <= 200
brewer?|

Brewer shown, e.g. a guest brewery.

style?|

Style shown, e.g. "Helles".

abv_pct?|

% ABV shown, e.g. 5.2.

ibu?|

IBU shown.

og_sg?|

Original gravity (SG, e.g. 1.048).

fg_sg?|

Final gravity (SG, e.g. 1.010).

color_ebc?|

Colour in EBC, e.g. 8. Send this or color_srm.

color_srm?|

Colour in SRM, e.g. 4 (tap lists store SRM). Send this or color_ebc.

description?|

Tasting notes shown on menus.

serving?array<>

How it is served, e.g. ["tap"] or ["bottle","can"]. Only "tap" beers can go on a tap.

Items1 <= items <= 4
available?boolean

false hides it from menus/screens (e.g. sold out); true shows it again.

position?integer

Place in the list, 1 = first.

Range1 <= value
[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/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": {}
  }
}