Pitch Deck

Remove one chapter.

Removes one chapter with everything already rendered on it; the remaining chapters are renumbered and keep their takes. NOT metered — and nothing is refunded: what the removed chapter bought is gone. A deck keeps at least one chapter. A draft plan, review or complete. On a draft plan nothing has rendered: the plan is renumbered (its black interludes follow their chapters) and the changed plan is queued for plan coverage again (planCoverage). Requires Idempotency-Key. Scope: story:write.

post/pitch-decks/{jobId}/chapters/remove

Request

  • Base URL: https://docs.sleeperhit.studio/api/v1
  • URL: https://docs.sleeperhit.studio/api/v1/pitch-decks/{jobId}/chapters/remove
  • Auth: HTTP bearer

Headers

Idempotency-Keystring required

Customer-generated stable identifier for safe retries of idempotent POST requests.

Request body

chapterIndexinteger required

The chapter to remove. The chapter's chapterIndex, exactly as the chapters read returns it: a key, not a position — a plan may key its chapters from 0 or from 1. A person's "chapter 2" is the chapter whose chapterNumber is 2; pass that chapter's chapterIndex.

Response

The deck's length after the edit.

successboolean required
chapterCountinteger required
planCoverage'queued' | 'current' | 'failed' | 'null' nullable

On a draft plan: the changed plan's plan coverage (queued for the latest edit, current, or failed — the approval says what is missing). Null in review or complete.

edited'draft_plan' | 'rendered_deck'

Which version of the deck the edit changed: draft_plan (a draft deck — nothing has rendered) or rendered_deck (a deck in review or complete). Tell the writer which one changed.

jobIdstring

The deck that changed.

status'draft' | 'review' | 'complete'

The deck's status after the edit (a complete deck goes back to review when a chapter is added).

Changes

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