BrewForge Docs

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

POST
/api/v1/actions/save_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).

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

Change this existing tap list (id or exact name). Omit to create a new one.

name?string

Name, e.g. "Home bar". Required to create.

Length1 <= length <= 100
description?string

Short text shown under the title on menus and screens.

Lengthlength <= 500
default_serving?string

How new beers are served by default: tap, bottle, can or growler (default tap).

Value in"tap" | "bottle" | "can" | "growler"
auto_add_completed?boolean

true = brews that reach completed are added automatically.

include_conditioning?boolean

true = also offer brews still conditioning when adding.

taps?integer

Create: also create this many taps, named "Tap 1", "Tap 2", ... (e.g. 4). Add more later with manage_tap action create.

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