notifications

Override a person's settings for one flow

The usual use is {"muted": true} — silence one noisy flow without touching anything else this person gets.

put/v1/notifications/preferences/flows/{flowId}

Request

  • Base URL: https://api.flowral.app
  • URL: https://api.flowral.app/v1/notifications/preferences/flows/{flowId}
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (client credentials, token URL https://api.flowral.app/v1/oauth/token, scopes: notifications:write)

Path parameters

flowIdstring required

Request body

memberIdstring required

The person these settings belong to.

emailboolean

The master switch for this scope. null means "inherit".

mutedboolean

Flow scope only: silence everything about this flow.

eventsobject

Per-event switches: assigned, unlocked, digest. Omit a key to leave it alone; send null to reset it to inherited.

timezonestring

Account scope only. IANA zone name — the digest is sent in this person's morning, not the server's.

digestHourinteger

Account scope only. 0–23, local. Default 8.

Response

SUCCESS

memberIdstring required
flowIdstring nullable

Null for the account-level answer.

emailboolean required

The master switch. False means no notification email at all, whatever the per-event flags say.

mutedboolean

Set by a flow-level override to silence one flow.

timezonestring

IANA zone. The digest is sent in this person's morning.

digestHourinteger

0–23, local.

Example response

{
  "timezone": "Europe/Paris"
}

Changes

No recorded changes to this operation across all 1 revision of this API.