Shows

Turn a show on, pause it, or turn it off.

Turn the show on, pause it, resume it (on) or turn it off. On lets it make and publish episodes on its schedule without asking each time, within its caps, under Sleeper's standing approval: it needs sources, a schedule, both caps, a project that can make an episode, and a preview made since the setup last changed, and takes userConfirmed: true. Off ends that approval, and an episode being made stops at its next step and is held. A show an outside app makes is never turned on (409 show_made_outside): revoke its standing approval first.

post/publishing-series/{seriesId}/show/state

Request

  • Base URL: https://docs.sleeperhit.studio/api/v1
  • URL: https://docs.sleeperhit.studio/api/v1/publishing-series/{seriesId}/show/state
  • Auth: HTTP bearer

Request body

state'on' | 'paused' | 'off' required
userConfirmedboolean

Required for on, after the user agrees the show may make and publish episodes without asking each time.

Response

The show as it now reads.

seriesIdstring required
state'not_set_up' | 'off' | 'on' | 'paused' | 'external' required
pausedReasonstring nullable required
showsRunningboolean required

False: shows aren't running across Sleeper (the operator's switch); a show made by Sleeper runs again when they do.

nextRunAtstring date-time nullable required

Changes

No recorded changes to this operation across all 1 revision of this API.