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`).
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).
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 brewsbrews:write: Create, update, delete brews and notesinventory:read: List inventory itemsinventory:write: Create, update, delete inventory itemsequipment:read: List equipment profilesequipment:write: Create, update, delete equipment profilesstyles:read: List style profilesstyles:write: Create, update, delete style profilesprofiles:read: List mash, fermentation, and water profilescustom-fields:read: List custom field definitionscustom-fields:write: Create, update, delete custom field definitionsprofiles:write: Create, update, delete mash, fermentation, and water profilescellar:read: View cellar, packaged stock, tap lists, and labelscellar:write: Manage cellar, packaging, stock, tap lists, and labelssettings:read: View preferences, imports, calculators, and your data exportsettings:write: Change preferences and undo importscommunity:read: View community, feedback, tickets, inbox, and account overviewcommunity:write: Post, vote, and reply in community, feedback, and tickets
In: header
Scope: community:write
Request Body
application/json
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.
What to do.
"follow" | "unfollow" | "block" | "unblock" | "remove_follower" | "report"report only (required): spam, copied (copied someone's recipe), offensive, impersonation or other.
"spam" | "copied" | "offensive" | "impersonation" | "other"report only: what is wrong, in the user's words (max 1000 characters).
length <= 1000report only: brew_id of the shared recipe the report is about, if any.
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": {}
}
}