BrewForge Docs

Follow, unfollow, block or report a brewer

Change the user's relation to another brewer: follow, unfollow, block (ends follows both ways), unblock, remove_follower (they stop following the user), or report (to the BrewForge team). Example: { "brewer": "hopfenhans", "action": "follow" }. Following needs the brewer's profile to be open. Reporting sends the user's complaint to the team: confirm the reason and wording with the user first and never report on your own initiative. Repeating follow/unfollow/block/unblock is harmless. Scope: `community:write` (or `write`).

POST
/api/v1/actions/interact_with_brewer

Change the user's relation to another brewer: follow, unfollow, block (ends follows both ways), unblock, remove_follower (they stop following the user), or report (to the BrewForge team). Example: { "brewer": "hopfenhans", "action": "follow" }. Following needs the brewer's profile to be open. Reporting sends the user's complaint to the team: confirm the reason and wording with the user first and never report on your own initiative. Repeating follow/unfollow/block/unblock is harmless.

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

brewer*string

The brewer: their handle (with or without @, e.g. "hopfenhans") as shown by browse_community or get_brewer_profile, or their user id from a connections list.

action*string

What to do.

Value in"follow" | "unfollow" | "block" | "unblock" | "remove_follower" | "report"
report_reason?string

report only (required): spam, copied (copied someone's recipe), offensive, impersonation or other.

Value in"spam" | "copied" | "offensive" | "impersonation" | "other"
report_details?string

report only: what is wrong, in the user's words (max 1000 characters).

Lengthlength <= 1000
report_brew_id?string

report only: brew_id of the shared recipe the report is about, if any.

[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/interact_with_brewer" \  -H "Content-Type: application/json" \  -d '{    "brewer": "string",    "action": "follow"  }'
{
  "brewer": {
    "user_id": "string",
    "handle": "string",
    "name": "string"
  },
  "action": "follow",
  "message": "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": {}
  }
}