Plans

Make one of a waiting plan's advised changes.

A waiting plan's advice is never a gate: the plan stays approvable either way. openingNovelty says when its opening echoes an earlier film of the same product and the one change that avoids it (alternative.field and alternative.value); signatureDeviceAgreement says which capture beats show a different device from the one the story's cast is always seen with (mismatchedBeatIds). Applying one changes only the beat it names and nothing else. Free. Send { kind: "opening", field, value } (from openingNovelty.alternative) or { kind: "device", beatIds } (from signatureDeviceAgreement.mismatchedBeatIds). Answers whether it changed anything and the advice after it. Naturally idempotent. The plan review card's button and Slug make the same change.

post/story-plans/{planId}/advice

Request

  • Base URL: https://docs.sleeperhit.studio/api/v1
  • URL: https://docs.sleeperhit.studio/api/v1/story-plans/{planId}/advice
  • Auth: HTTP bearer

Request body

OR

Response

What the change did, and the advice after it.

planIdstring required
appliedboolean required

False when there was nothing to change (no such beat, no stated device, or an opening value that would read on the other side); the plan is then untouched.

Changes

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