Sources

Store a tour for one feature of the project.

Binds the tour document (tour, stored as written) to one of the project's features (featureId, a Series Bible episode), with an optional label; the tour's name is taken from the document itself. A document the recorder could not run is refused VERBATIM with its problems (400 validation_failed, details.errors) and nothing is stored; the answer's check re-runs that check. 409 tour_limit_reached past 200 (TOURS_PER_PROJECT_MAX) tours per project. Requires Idempotency-Key. Free.

post/story-projects/{projectId}/tours

Request

  • Base URL: https://docs.sleeperhit.studio/api/v1
  • URL: https://docs.sleeperhit.studio/api/v1/story-projects/{projectId}/tours
  • Auth: HTTP bearer

Headers

Idempotency-Keystring required

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

Request body

featureIdstring required

The feature (a Series Bible episode) the tour walks through.

tourobject required

The tour document. Refused (validation_failed, details.errors) with the recorder's own problems; nothing stored.

labelstring

Free text beside the tour on every surface.

Response

The stored tour.

Changes

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