Skip to content

SDK method

tools.setNotificationSchedule

Set notification schedule. Convenience alias for set_notification_schedule, forwarding to tinbox.api.digests.setPreset.mutate.

Signature

ts
setNotificationSchedule(input: Parameters<TinboxTools["setNotificationSchedule"]>[0]): ReturnType<TinboxTools["setNotificationSchedule"]>

Parameters

NameTypeRequiredDescription
preset"every" | "important" | "daily" | "weekly" | "never"yes—
targetstringnoOptional destination email; defaults to the account email.

Returns

ReturnType<TinboxTools["setNotificationSchedule"]>

Example

ts
await tinbox.tools.setNotificationSchedule({
  "preset": "every"
});