BrewForge Docs

Apply a profile to brews

Push an equipment, mash or fermentation profile into brews. Brews keep their own copy of profiles, so changing a profile does not change existing brews until you apply it. With brew: replace that one brew's equipment / mash steps / fermentation stages with the profile (equipment with scale_recipe: true also scales the ingredient amounts to the new batch size; idea/planned brews only). Without brew: refresh every idea/planned brew that is linked to this profile. Without confirm: true it only returns how many brews would change. Imported brews get a new version instead of being changed. Destructive: without `confirm: true` nothing changes and the response is `{ needs_confirmation: true, would_delete, message }`. Needs the plan feature `profiles`. Scope: `brews:write` (or `write`).

POST
/api/v1/actions/apply_profile

Push an equipment, mash or fermentation profile into brews. Brews keep their own copy of profiles, so changing a profile does not change existing brews until you apply it. With brew: replace that one brew's equipment / mash steps / fermentation stages with the profile (equipment with scale_recipe: true also scales the ingredient amounts to the new batch size; idea/planned brews only). Without brew: refresh every idea/planned brew that is linked to this profile. Without confirm: true it only returns how many brews would change. Imported brews get a new version instead of being changed.

Destructive: without confirm: true nothing changes and the response is { needs_confirmation: true, would_delete, message }. Needs the plan feature profiles. 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

kind*string

"equipment", "mash" or "fermentation" (water and hop stand profiles are chosen in the recipe).

Value in"equipment" | "mash" | "fermentation"
profile*string

The profile: its id or its exact name (e.g. "Grainfather G30"). Case does not matter. Use find_profiles to see the names.

brew?string

Only this brew. 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. Omit to update all linked idea/planned brews.

scale_recipe?boolean

Equipment with one brew only: also scale ingredient amounts to the profile's batch size (default false).

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/apply_profile" \  -H "Content-Type: application/json" \  -d '{    "kind": "equipment",    "profile": "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": {}
  }
}