notifications

What a person is subscribed to on one flow

The account settings with this flow's override applied.

get/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:read)

Path parameters

flowIdstring required

Query parameters

memberIdstring required

The person these settings belong to. A credential has no inbox, so this is never optional.

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.