Skip to content
GitmoapAPIBeta
Schema

NotificationPreferences

Your notification preferences: every category on every channel, and when email may reach you.

Shape

  • preferencesarray of NotificationPreferenceOne entry per category and channel, whether you have changed it or not.
    • The NotificationPreference schema
    • categoryNotificationCategorygate_requestedgate_expiringescalationquestion_to_youmentiondigest_readybudget_thresholdritual_inviteWhat the notification is about.
    • channelNotificationChannelin_appemailWhere it reaches you.
    • modeNotificationModeimmediatedigestoffHow it reaches you there — your choice, or the category's default.
    • requiredbooleanWhether the category cannot be turned off.
  • settingsNotificationSettingsWhen email may reach you.
    • The NotificationSettings schema
    • digest_frequencyDigestFrequencyhourlydailyWhether digests are sent hourly or daily.
    • digest_hourinteger · int320–23The local hour, 0 to 23, a daily digest is sent at.
    • time_zoneTimeZoneName (string)The time zone your quiet hours and digest hour are in.
    • quiet_hoursQuietHours or nulloptionalHours in which email waits, unless what it reports cannot be turned off. Absent when email is never held back.
      • The QuietHours schema
      • from_hourinteger · int320–23The first quiet hour, 0 to 23, in your time zone.
      • until_hourinteger · int320–23The hour email may be sent again, 0 to 23, in your time zone. Differs from from_hour.

Example

Synthesized example
{
"preferences": [
{
"category": "gate_requested",
"channel": "in_app",
"mode": "immediate",
"required": false
},
{
"category": "gate_requested",
"channel": "in_app",
"mode": "immediate",
"required": false
}
],
"settings": {
"digest_frequency": "hourly",
"digest_hour": 1,
"time_zone": "time-zone-b66a",
"quiet_hours": {
"from_hour": 1,
"until_hour": 0
}
}
}

Graph

Used inside

No schema contains this one.

Used by

Sent by 0 operations

No operation takes it as a request body.