Skip to content
shuffl
Get started

Searches the public product guides only. Nothing from a workspace is read, and questions are not saved.

Reference

Reminders API

4 operations. Generated from the OpenAPI document, so this page always matches the API.

OpenAPI documentErrors and rate limitsSDK and CLI recipes

On this page

reminders.mine

Read your own Praise and Pulse reminder choices

POST/api/v1/manage/reminders/mine

const result = await shuffl.reminders.mine();
Request fields (none)

This operation takes no input.

Response object
  • kinds object[] required
    • choice "before_close" | "default" | "every_2_weeks" | "monthly" | "next_day" | "off" | "once_a_month" | "once_a_week" | "one_day_late" | "quarterly" | "three_days_late" required
    • effective "before_close" | "every_2_weeks" | "monthly" | "next_day" | "off" | "once_a_month" | "once_a_week" | "one_day_late" | "quarterly" | "three_days_late" required
    • kind "network" | "playbook_todo" | "praise" | "pulse" required
    • options "before_close" | "every_2_weeks" | "monthly" | "next_day" | "once_a_month" | "once_a_week" | "one_day_late" | "quarterly" | "three_days_late"[] required
    • team "before_close" | "every_2_weeks" | "monthly" | "next_day" | "off" | "once_a_month" | "once_a_week" | "one_day_late" | "quarterly" | "three_days_late" required
  • linked boolean required

reminders.settings

Read whether Praise and Pulse reminders are on, and their timing

POST/api/v1/manage/reminders/settings

const result = await shuffl.reminders.settings();
Request fields (none)

This operation takes no input.

Response object
  • network object required
    • available boolean required
    • choice "before_close" | "every_2_weeks" | "monthly" | "next_day" | "off" | "once_a_month" | "once_a_week" | "one_day_late" | "quarterly" | "three_days_late" required
    • days number[] required
    • optedOut number required
    • options string[] required
  • playbook_todo object required
    • available boolean required
    • choice "before_close" | "every_2_weeks" | "monthly" | "next_day" | "off" | "once_a_month" | "once_a_week" | "one_day_late" | "quarterly" | "three_days_late" required
    • days number[] required
    • optedOut number required
    • options string[] required
  • praise object required
    • available boolean required
    • choice "before_close" | "every_2_weeks" | "monthly" | "next_day" | "off" | "once_a_month" | "once_a_week" | "one_day_late" | "quarterly" | "three_days_late" required
    • days number[] required
    • optedOut number required
    • options string[] required
  • pulse object required
    • available boolean required
    • choice "before_close" | "every_2_weeks" | "monthly" | "next_day" | "off" | "once_a_month" | "once_a_week" | "one_day_late" | "quarterly" | "three_days_late" required
    • days number[] required
    • optedOut number required
    • options string[] required

reminders.saveMine

Change or turn off your own Praise or Pulse reminders

POST/api/v1/manage/reminders/saveMine

  • Write
  • Permission reminders.saveMine
  • Needs a requestKey
  • Needs confirm set to reminders.saveMine
const result = await shuffl.reminders.saveMine({
  "choice": "<choice>",
  "kind": "network",
  "confirm": "reminders.saveMine",
  "requestKey": "a-new-unique-key"
});
Request fields (4)
  • choice string required
  • kind "network" | "playbook_todo" | "praise" | "pulse" required
  • confirm "reminders.saveMine" required
  • requestKey string required1 to 128 characters
Response object
  • receipt object required
    • completedAt string (date-time) | null required
    • createdAt string (date-time) required
    • id string (uuid) required
    • operation string required
    • requestKey string required
    • status "running" | "succeeded" | "failed" | "unknown" required
  • result object | null required
    • changed boolean required
    • kinds object[] required
      • choice "before_close" | "default" | "every_2_weeks" | "monthly" | "next_day" | "off" | "once_a_month" | "once_a_week" | "one_day_late" | "quarterly" | "three_days_late" required
      • effective "before_close" | "every_2_weeks" | "monthly" | "next_day" | "off" | "once_a_month" | "once_a_week" | "one_day_late" | "quarterly" | "three_days_late" required
      • kind "network" | "playbook_todo" | "praise" | "pulse" required
      • options "before_close" | "every_2_weeks" | "monthly" | "next_day" | "once_a_month" | "once_a_week" | "one_day_late" | "quarterly" | "three_days_late"[] required
      • team "before_close" | "every_2_weeks" | "monthly" | "next_day" | "off" | "once_a_month" | "once_a_week" | "one_day_late" | "quarterly" | "three_days_late" required
    • linked boolean required

reminders.saveSetting

Turn a Praise or Pulse reminder on or off, or change its timing

POST/api/v1/manage/reminders/saveSetting

const result = await shuffl.reminders.saveSetting({
  "choice": "<choice>",
  "kind": "network",
  "confirm": "reminders.saveSetting",
  "requestKey": "a-new-unique-key"
});
Request fields (5)
  • choice string required
  • days number[] optional
  • kind "network" | "playbook_todo" | "praise" | "pulse" required
  • confirm "reminders.saveSetting" required
  • requestKey string required1 to 128 characters
Response object
  • receipt object required
    • completedAt string (date-time) | null required
    • createdAt string (date-time) required
    • id string (uuid) required
    • operation string required
    • requestKey string required
    • status "running" | "succeeded" | "failed" | "unknown" required
  • result object | null required
    • changed boolean required
    • choice "before_close" | "every_2_weeks" | "monthly" | "next_day" | "off" | "once_a_month" | "once_a_week" | "one_day_late" | "quarterly" | "three_days_late" required
    • days number[] required
    • kind "network" | "playbook_todo" | "praise" | "pulse" required