Mark inbox items as read or archive messages
Mark things in the user's inbox as read, like opening them in the app: team messages (by id, or all), a ticket's replies, Feedback notifications (by id, or all) and community notices; archive team messages. Pass only what to change. Example: { "ticket": 412, "all_feedback_notifications": true }. Ids come from get_inbox. Only do this when the user has seen the items or asked for it. Scope: `community:write` (or `write`).
Mark things in the user's inbox as read, like opening them in the app: team messages (by id, or all), a ticket's replies, Feedback notifications (by id, or all) and community notices; archive team messages. Pass only what to change. Example: { "ticket": 412, "all_feedback_notifications": true }. Ids come from get_inbox. Only do this when the user has seen the items or asked for it.
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
Team message ids (get_inbox messages.items[].id) to mark read.
items <= 100true: mark every team message and ticket reply as read.
Team message ids to archive (hidden from the inbox, not deleted).
items <= 100Mark this ticket's team replies as read. The support ticket: its number (412 or "#412") or id, from get_inbox.
Feedback notification ids (get_inbox feedback_notifications.items[].id).
items <= 100true: mark every Feedback notification read.
true: mark the community notices (follows, cheers) as seen.
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/mark_inbox_read" \ -H "Content-Type: application/json" \ -d '{}'{
"marked_read": 0,
"archived": 0,
"ticket": 0,
"feedback_unread": 0,
"community_notices_seen": true,
"needs_attention": 0
}{
"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": {}
}
}