BrewForge Docs

Change a profile

Change some settings of one own profile; everything you do not send stays as it is. Rename with name, make it the default for new brews with is_default: true. Settings go into the object of the profile's kind, e.g. {"kind": "equipment", "profile": "Grainfather G30", "equipment": {"boil_off_rate": 3.2}}. Mash steps, fermentation stages and hop stand points are replaced as a whole list. Brews keep their own copy of a profile: to push the change into planned brews afterwards, call apply_profile. Returns the profile with all settings. Needs the plan feature `profiles`. Scope: `profiles:write` (or `write`).

POST
/api/v1/actions/update_profile

Change some settings of one own profile; everything you do not send stays as it is. Rename with name, make it the default for new brews with is_default: true. Settings go into the object of the profile's kind, e.g. {"kind": "equipment", "profile": "Grainfather G30", "equipment": {"boil_off_rate": 3.2}}. Mash steps, fermentation stages and hop stand points are replaced as a whole list. Brews keep their own copy of a profile: to push the change into planned brews afterwards, call apply_profile. Returns the profile with all settings.

Needs the plan feature profiles. Scope: profiles: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: profiles:write

Request Body

application/json

kind*string

Profile kind: "equipment" (brewhouse volumes, losses, efficiency), "mash" (mash steps), "fermentation" (fermentation stages), "water" (water report ions) or "hop_stand" (temperature curve after flame-out).

Value in"equipment" | "mash" | "fermentation" | "water" | "hop_stand"
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.

name?string

New name.

Length1 <= length <= 100
description?|

New note; null clears it.

is_default?boolean

true: make this the default for new brews (the previous default stops being one). Not for hop_stand.

equipment?

Equipment settings (kind equipment), only what you set. Fields include batch_volume_l, boil_time_min, boil_off_rate + boil_off_rate_mode (volume=L/h, percentage=%/h), brewhouse_efficiency_pct, trub_chiller_loss_l, fermenter_loss_l, kettle_max_volume_l / mash_tun_max_volume_l (vessel sizes), water_calculation, hop_stand_curve (get_profile lists all).

mash?

Mash settings (kind mash): grain_temp_c and steps: [{name, temp_c, duration_min, type?: "temperature"|"infusion"|"decoction", ramp_min?}]. Example: {"steps": [{"name": "Saccharification", "temp_c": 67, "duration_min": 60}]}.

fermentation?

Fermentation settings (kind fermentation): stages: [{name, temp_c, duration_days, type?: primary|secondary|cold_crash|conditioning|..., pressure_psi?, spunding?}]. Example: {"stages": [{"name": "Primary", "temp_c": 19, "duration_days": 10}]}.

water?

Water report (kind water), ions in mg/L (ppm): calcium_ppm, magnesium_ppm, sodium_ppm, chloride_ppm, sulfate_ppm, bicarbonate_ppm, ph, conductivity_us_cm. Example: {"calcium_ppm": 80, "sulfate_ppm": 110, "bicarbonate_ppm": 150}.

hop_stand?

Hop stand curve (kind hop_stand): points: [{time_min, temp_c}], first at time_min 0. Example: {"points": [{"time_min": 0, "temp_c": 95}, {"time_min": 30, "temp_c": 70}]}.

[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_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": {}
  }
}