---
title: "Pause optional notification email temporarily"
method: POST
path: "/notifications/mutes"
tags: ["Notifications"]
---

# Pause optional notification email temporarily

`POST /notifications/mutes`

## Request

- Base URL: `https://app.openpo.st/api/v1`
- URL: `https://app.openpo.st/api/v1/notifications/mutes`
- Auth: one of:
  - HTTP bearer
  - API key in cookie `openpost_session`

Creates or replaces the current account-wide or Workspace-specific Mute. In-app notifications remain immediate and Transactional email always bypasses Mutes.

## Request body

- MuteCreate
  - `$schema` string, uri: A URL to the JSON Schema for this object.
  - `ends_at` string, date-time, required
  - `scope` 'account' | 'workspace', required
  - `workspace_id` string

## Response `200`

OK

- PreferenceSettings
  - `$schema` string, uri: A URL to the JSON Schema for this object.
  - `digest_configured` boolean, required
  - `digest_time` string, required
  - `digest_timezone` string, required
  - `email_address` string, required
  - `email_available` boolean, required
  - `mutes` Mute[], nullable, required
    - `ends_at` string, date-time, required
    - `id` string, required
    - `scope` 'account' | 'workspace', required
    - `starts_at` string, date-time, required
    - `workspace_id` string
    - `workspace_name` string
  - `preferences` object, required
  - `topic_definitions` TopicDefinition[], nullable, required
    - `critical_in_app` boolean, required
    - `default_preference` ChannelPreference, required
      - `email_frequency` 'off' | 'immediate' | 'daily', required
      - `in_app` boolean, required
    - `email_frequencies` string[], nullable, required
    - `email_mutable` boolean, required
    - `group` string, required
    - `id` string, required
    - `in_app_mutable` boolean, required
    - `mute_applies` boolean, required
    - `presentation_key` string, required
    - `transactional` boolean, required

## Other responses

- `400`: Bad Request
- `403`: Forbidden
- `422`: Unprocessable Entity
- `500`: Internal Server Error

---

[API](https://skmtc.dev/openpo/apis/openpost-api.md) · [All operations](https://skmtc.dev/openpo/apis/openpost-api/llms.txt) · [OpenAPI document](https://skmtc.dev/openpo/apis/openpost-api/revisions/67d3964458a7?raw)