storyboards

Stop a storyboard

Stop planning. A storyboard that has not started is cancelled at once; one that is running stops at its next step boundary, which is a few seconds. Planning holds no video time, so nothing is refunded — there was nothing to refund. A storyboard that has already finished, failed or been cancelled is 409 already_settled, and nothing changes.

post/storyboards/{id}/cancel

Request

  • Base URL: https://api.gogoscreen.com/api/v1
  • URL: https://api.gogoscreen.com/api/v1/storyboards/{id}/cancel
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Path parameters

idstring uuid required

The resource id, from a create answer or the matching list.

Headers

Idempotency-Keystring required

1–128 characters, unique to this request. A retry with the same key and the same body returns the STORED response with Idempotent-Replayed: true; the same key with a different body is 409 idempotency_conflict; a duplicate still in flight is 409 idempotency_in_progress. Claims expire after 24 hours.

Response

Stop a storyboard

removedFromQueueboolean required

Changes

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