Notify API reference

Notify API · Settings

patch/v1/workspaces/{workspace_id}/settingsAuth

Update Notify settings

Turn email on or off, set the default time zone and quiet hours (`null` clears either), replace the browser origins allowed on the client API (`client_origins`), or resume email after an automatic pause with `{ "email_paused": false }`. Resuming starts a fresh pause window: only emails sent after it count. Fix the cause first (where the addresses come from, whether people expect the email), or the next complaints pause it again. Calling it again with the same body changes nothing.

Path parameters

workspace_id*string · uuid

Id of the workspace.

Request body

email_enabledboolean

Turn Notify email on or off for the workspace.

email_pausedenum (1)

Send `false` to resume email after an automatic pause. Pausing by hand is not supported: turn `email_enabled` off instead.

default_timezonestring

IANA time zone used for recipients without one. `null` clears it.

Example: "Europe/Lisbon"

default_quiet_hoursobject

Quiet hours for recipients who set none, e.g. `{ "start": "22:00", "end": "08:00" }` (an end before the start spans midnight). `null` clears it.

client_originsarray

Replaces the browser origins allowed to call the client API: `https://host[:port]` (or `http://localhost[:port]`), no path. `[]` goes back to localhost only.

Example: ["https://app.example.com","https://www.example.com"]

Response · 200 The settings after the change.

email_enabled*boolean

Whether Notify sends email for this workspace. Off: every email delivery is skipped as `channel_not_configured`.

email_paused_at*string · date-time

Set when Notify paused email automatically: more than 0.1 % complaints or 5 % hard bounces among the last 500 email deliveries (counted once at least 100 exist). While set, email deliveries are skipped as `email_paused`, critical types included. Clear it with `PATCH` `{ "email_paused": false }`.

email_paused_reason*string

Why email was paused, e.g. "2 complaints in the last 140 emails".

email_resumed_at*string · date-time

When email was last resumed after a pause. The pause check only counts emails sent after it.

default_timezone*string

IANA time zone for recipients who have none on their profile (and no time zone on the device, for push). Null: recipients without a time zone are never held for quiet hours.

Example: "Europe/Lisbon"

default_quiet_hours*object

Quiet hours for recipients who set none of their own. Push and web push wait until the window ends (plus up to 10 minutes, so a morning backlog spreads out); email waits only for types with `email_quiet_hours`; the inbox and critical types never wait. A hold past the type TTL fails as `expired`.

client_origins*array

Browser origins allowed to call the client API (`/v1/client/…`) with a recipient token. Empty: only `http://localhost` (any port) is accepted, for development. Calls without an `Origin` header (native apps) are not origin-checked.

Example: ["https://app.example.com"]

Example

Request

PATCH https://api.notify.productcraft.co/v1/workspaces/{workspace_id}/settings
Authorization: Bearer YOUR_TOKEN
Content-Type: application/json

{
  "email_enabled": false,
  "email_paused": false,
  "default_timezone": "Europe/Lisbon",
  "default_quiet_hours": {},
  "client_origins": [
    "https://app.example.com",
    "https://www.example.com"
  ]
}

Response

{
  "email_enabled": false,
  "email_paused_at": "2026-01-01T00:00:00.000Z",
  "email_paused_reason": "string",
  "email_resumed_at": "2026-01-01T00:00:00.000Z",
  "default_timezone": "Europe/Lisbon",
  "default_quiet_hours": {},
  "client_origins": [
    "https://app.example.com"
  ]
}