BrewForge Docs

Update the community profile and shared recipes

Change the user's community profile: handle, who can see it (visibility), bio, location, brewing since, brewhouse, which activity is shown, notifications; list recipes on the profile (list_brews: other brewers can see and copy them) or take them off (unlist_brews), and hide single activity entries. Only the fields you pass change. Example: { "visibility": "members", "bio": "Lager nerd from Franconia", "list_brews": ["#12"] }. Making the profile or a recipe visible is public-facing: do it only when the user asked. Listing needs a visible profile (visibility members or public). Read the current settings with get_brewer_profile (no brewer). Scope: `community:write` (or `write`).

POST
/api/v1/actions/update_community_profile

Change the user's community profile: handle, who can see it (visibility), bio, location, brewing since, brewhouse, which activity is shown, notifications; list recipes on the profile (list_brews: other brewers can see and copy them) or take them off (unlist_brews), and hide single activity entries. Only the fields you pass change. Example: { "visibility": "members", "bio": "Lager nerd from Franconia", "list_brews": ["#12"] }. Making the profile or a recipe visible is public-facing: do it only when the user asked. Listing needs a visible profile (visibility members or public). Read the current settings with get_brewer_profile (no brewer).

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

Request Body

application/json

handle?string

Public handle (username), 3-30 letters, digits, _ or ., e.g. "hopfenhans". Unique across BrewForge.

visibility?string

private (only the user), members (signed-in BrewForge brewers) or public (anyone with the link).

Value in"private" | "members" | "public"
bio?string

Short bio, max 400 characters. Empty string clears it.

Lengthlength <= 400
location?string

e.g. "Bamberg, Germany". Empty string clears it.

Lengthlength <= 80
brewing_since?integer

Year the user started brewing, e.g. 2016.

Range1900 <= value
brewhouse?string

Name of the brewery/system, e.g. "Braumeister 20L". Empty string clears it.

Lengthlength <= 80
activity_mode?string

Which activity followers see: all (every brew), listed (only brews whose recipe is on the profile) or none.

Value in"listed" | "all" | "none"
activity_events?

Turn single kinds of activity on/off, e.g. { "packaged": false }.

notify_recipe_brewed?boolean

Notify the user when someone brews a copy of their shared recipe.

indexable?boolean

Let search engines index the profile (public profiles only).

list_brews?array<>

Brews whose recipe to show on the profile. 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.

Itemsitems <= 50
unlist_brews?array<>

Brews whose recipe to take off the profile (its share link keeps working). 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.

Itemsitems <= 50
hide_activity?array<>

Activity entries of the user's own brews to hide from the feed and profile.

Itemsitems <= 50
[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_community_profile" \  -H "Content-Type: application/json" \  -d '{}'
{
  "settings": {
    "handle": "string",
    "visibility": "private",
    "bio": "string",
    "location": "string",
    "brewing_since": 0,
    "brewhouse": "string",
    "activity_mode": "listed",
    "activity_events": {
      "property1": true,
      "property2": true
    },
    "notify_recipe_brewed": true,
    "indexable": true
  },
  "listed": [
    {
      "brew_id": "string",
      "name": "string",
      "share_token": "string"
    }
  ],
  "unlisted": [
    {
      "brew_id": "string",
      "name": "string"
    }
  ],
  "hidden_activity": [
    {
      "brew_id": "string",
      "kind": "brewed"
    }
  ]
}
{
  "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": {}
  }
}