BrewForge Docs

Rename, date, tag or pin a brew

Change a brew's details (not its recipe): name, description, planned brew day, actual brew date, ready-by date, tags, pin. Send only what changes; null clears a date. Setting planned_date on an idea also makes it "planned" (it gets a batch number), which is how you plan a brew for a day. For other status changes use set_brew_status; for ingredients and process use update_recipe. Scope: `brews:write` (or `write`).

POST
/api/v1/actions/update_brew

Change a brew's details (not its recipe): name, description, planned brew day, actual brew date, ready-by date, tags, pin. Send only what changes; null clears a date. Setting planned_date on an idea also makes it "planned" (it gets a batch number), which is how you plan a brew for a day. For other status changes use set_brew_status; for ingredients and process use update_recipe.

Scope: brews: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: brews:write

Request Body

application/json

brew*string

The brew: its id, its batch number (e.g. 12 or "#12") or its exact name (e.g. "Citra Pale Ale"). Case does not matter.

name?string

New name, e.g. "Citra Pale Ale v2".

Length1 <= length <= 200
description?|

New description; null clears it.

planned_date?|

Planned brew day as YYYY-MM-DD (e.g. "2026-11-21"); null clears it. Plans an idea.

brew_date?|

Actual brew day (for brews already brewed) (YYYY-MM-DD, e.g. "2026-11-07").

ready_by_date?|

Date the beer must be ready by (YYYY-MM-DD, e.g. "2026-12-24").

ready_by_note?|

What it must be ready for, e.g. "Christmas party"; null clears it.

tags?array<>

Replace all tags, e.g. ["hoppy"]. [] removes all.

add_tags?array<>

Tags to add, keeping the others, e.g. ["competition"].

remove_tags?array<>

Tags to remove.

pinned?boolean

Pin (true) or unpin (false) the brew in the sidebar.

brew_type?string

Brew type.

Value in"all_grain" | "partial_mash" | "extract"
[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/update_brew" \  -H "Content-Type: application/json" \  -d '{    "brew": "string"  }'
{
  "brew": {
    "id": "string",
    "name": "string",
    "batch_number": 0,
    "status": "idea",
    "recipe_id": "string",
    "version": "string",
    "planned_date": "string",
    "brew_date": "string",
    "ready_by_date": "string"
  },
  "tags": [
    "string"
  ],
  "pinned": true,
  "notes": [
    "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": {}
  }
}