Learn how to read a board’s muted notification settings via the platform API
Notifications are a core part of monday.com, helping users and teams stay up to date on important changes, assignments, and mentions. However, there are times when users or board owners may want to reduce noise by muting notifications for specific boards.
Queries
Get mute board settings
- Returns a board's muted notification settings
- Can only be queried at the root; cannot be nested within another query
query {
mute_board_settings(board_ids: [1234567890]) {
board_id
mute_state
}
}{
"data": {
"mute_board_settings": [
{
"board_id": "1234567890",
"mute_state": "CURRENT_USER_MUTE_ALL"
}
]
},
"extensions": {
"request_id": "YOUR_REQUEST_ID"
}
}Arguments
| Argument | Type | Description |
|---|---|---|
| board_ids | [ID!]! | The unique identifiers of the boards to retrieve mute settings for. |
Fields
| Field | Type | Description | Enum Values |
|---|---|---|---|
| board_id | ID | The board's unique identifier. | |
| mute_state | BoardMuteState | The board's mute state. | • CURRENT_USER_MUTE_ALL: current user has all notifications muted• MENTIONS_AND_ASSIGNS_ONLY: current user is only notified when mentioned or assigned something• MUTE_ALL: board owner has all notifications for all users are muted• NOT_MUTED: board owner has nothing muted for all users |
Mutations
Update mute board settings
Updates the mute notification settings for a specific board. Returns [BoardMuteSettings!].
mutation {
update_mute_board_settings(
board_id: "1234567890",
enabled: IM_ASSIGNED,
mute_state: CUSTOM_SETTINGS
) {
enabled
mute_state
board_id
}
}{
"data": {
"update_mute_board_settings": [
{
"enabled": [
"IM_ASSIGNED"
],
"mute_state": "CUSTOM_SETTINGS",
"board_id": "1234567890"
}
]
},
"extensions": {
"request_id": "YOUR_REQUEST_ID"
}
}Arguments
| Argument | Type | Description | Enum Values |
|---|---|---|---|
| board_id | String! | The unique identifier of the board to update the mute settings for. | |
| enabled | [CustomizableBoardSettings!] | An array specifying which custom settings are enabled. Only used for CUSTOM_SETTINGS mute state. | • AUTOMATION_NOTIFIED: notify the current user when an automation reaches a “notify” step on this board• IM_ASSIGNED: notify the current user when they're assigned on the board• IM_MENTIONED: notify the current user when they're mentioned on the board |
| mute_state | BoardMuteState! | The desired board mute state. | • CURRENT_USER_MUTE_ALL: mute all notifications for the current user• CUSTOM_SETTINGS: notify the current user for the enabled custom settings (must be used with the enabled argument)• MENTIONS_AND_ASSIGNS_ONLY: notify the current user only when they are mentioned or assigned something• MUTE_ALL: mute all notifications for all users (admin-only)• NOT_MUTED: unmute everything (admin-only) |
