Notification Preferences

Get account notification preferences

Changed on

Returns the account notification settings for the API key's own user in the active company, along with the modes each event supports and the platform defaults. Every event available to the requesting client is present; an event the user has never configured reports its default. Default Node and Undici clients must send x-sequenzy-client to receive weekly_report. There is no way to read another member's preferences through this API. Requires account:read.

get/notification-preferences

Request

  • Base URL
    https://api.sequenzy.com/api/v1
  • URL
    https://api.sequenzy.com/api/v1/notification-preferences
  • Auth
    HTTP bearer

Headers

x-sequenzy-clientstring

Identifies a client that supports the complete notification event list, including weekly_report. Any non-empty value opts a default Node or Undici client into the full response.

Response

Notification preferences returned

successboolean
supportedModesobject

Modes each event accepts, keyed by event.

defaultsobject

Mode each event uses when the user has never configured it, resolved for the API key's user. The workspace owner defaults to weekly_report "weekly" and account_health "instant"; invited members default to "off".

Changes

  • db3873ca3d4dRevision changes
    • warning

      added the new account_health enum value to the // response property for the response status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 7d51110ba99aRevision changes
    • warning

      added the new weekly enum value to the // response property for the response status

    • warning

      added the new weekly_report enum value to the // response property for the response status

    • info

      added the new optional header request parameter x-sequenzy-client