BrewForge Docs

Change a brew's status

Move a brew through its lifecycle: idea → planned → brewing → fermenting → conditioning → completed → archived. The app's side effects happen as in the UI: planning assigns a batch number, brewing sets the brew date (today unless you pass date), conditioning records its start, completing adds the beer to tap lists set to auto-add. Unusual moves (backwards, skipping steps, archiving early) return needs_confirmation with the app's warning and change nothing; repeat with confirm: true after checking with the user. Brew-day measurements, packaging and cellar moves are separate tools. Scope: `brews:write` (or `write`).

POST
/api/v1/actions/set_brew_status

Move a brew through its lifecycle: idea → planned → brewing → fermenting → conditioning → completed → archived. The app's side effects happen as in the UI: planning assigns a batch number, brewing sets the brew date (today unless you pass date), conditioning records its start, completing adds the beer to tap lists set to auto-add. Unusual moves (backwards, skipping steps, archiving early) return needs_confirmation with the app's warning and change nothing; repeat with confirm: true after checking with the user. Brew-day measurements, packaging and cellar moves are separate tools.

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.

status*string

New status, e.g. "fermenting".

Value in"idea" | "planned" | "brewing" | "fermenting" | "conditioning" | "completed" | "archived"
date?string

For "planned": the planned brew day. For "brewing" and later: the actual brew date if it is not today. Ignored otherwise (YYYY-MM-DD, e.g. "2026-11-21").

Match^\d{4}-\d{2}-\d{2}$
confirm?boolean

true to do an unusual move (backwards, skipping steps, archiving early) after a needs_confirmation answer.

[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/set_brew_status" \  -H "Content-Type: application/json" \  -d '{    "brew": "string",    "status": "idea"  }'
{
  "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"
  },
  "previous_status": "idea",
  "changes": [
    "string"
  ],
  "warning": "string",
  "next_step": "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": {}
  }
}