BrewForge Docs

Answer a feedback questionnaire

Submit (or change) the user's answers to the open questionnaire of a feature request, which the BrewForge team uses to decide how to build it. First read the questions and option ids with get_feedback_thread (questionnaires[]), ask the user, then pass one answer per question. Example: { "thread": 33, "answers": [{ "question_id": "q1", "option_ids": ["per-step"] }, { "question_id": "q2", "option_ids": [], "other": "only for decoction" }] }. Every question needs an answer; single-choice questions take exactly one option (or other). The result shows the totals so far. Scope: `community:write` (or `write`).

POST
/api/v1/actions/answer_feedback_questionnaire

Submit (or change) the user's answers to the open questionnaire of a feature request, which the BrewForge team uses to decide how to build it. First read the questions and option ids with get_feedback_thread (questionnaires[]), ask the user, then pass one answer per question. Example: { "thread": 33, "answers": [{ "question_id": "q1", "option_ids": ["per-step"] }, { "question_id": "q2", "option_ids": [], "other": "only for decoction" }] }. Every question needs an answer; single-choice questions take exactly one option (or other). The result shows the totals so far.

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

thread*|

The feedback thread: its number (33, "#33") or its URL (e.g. "https://brewforge.sh/feedback/33-water-per-mash-step"). Find numbers with find_feedback_threads.

questionnaire_id?string

Questionnaire id from get_feedback_thread; default: the thread's open questionnaire.

answers*array<>

One entry per question.

Items1 <= items
[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/answer_feedback_questionnaire" \  -H "Content-Type: application/json" \  -d '{    "thread": 0,    "answers": [      {        "question_id": "string",        "option_ids": [          "string"        ]      }    ]  }'
{
  "thread": 0,
  "questionnaire_id": "string",
  "saved": true,
  "moderation": "published",
  "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": {}
  }
}