Skip to content
shuffl
Get started

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

Reference

Workspace launch API

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

OpenAPI documentErrors and rate limitsSDK and CLI recipes

On this page

team.launchPost

Read the launch announcement for the workspace

POST/api/v1/manage/team/launchPost

const result = await shuffl.team.launchPost();
Request fields (none)

This operation takes no input.

Response object
  • dismissed boolean required

team.answerMinutes

Set the team estimate of minutes per HR question, used for time saved

POST/api/v1/manage/team/answerMinutes

  • Write
  • Permission team.answerMinutes
  • Needs a requestKey
  • Needs confirm set to team.answerMinutes
const result = await shuffl.team.answerMinutes({
  "minutes": 0,
  "confirm": "team.answerMinutes",
  "requestKey": "a-new-unique-key"
});
Request fields (3)
  • minutes null | number required
  • confirm "team.answerMinutes" 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
    • minutes null | number required

team.dismissLaunchPost

Dismiss the Tell your team what they can ask post on Today for everyone

POST/api/v1/manage/team/dismissLaunchPost

const result = await shuffl.team.dismissLaunchPost({
  "reason": "dismissed",
  "confirm": "team.dismissLaunchPost",
  "requestKey": "a-new-unique-key"
});
Request fields (3)
  • reason "dismissed" | "posted" required
  • confirm "team.dismissLaunchPost" 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
    • dismissed boolean required