marketing

Stop an export

Stop an export that has not finished and hand the reserved video time back whole. An export that has already succeeded, failed or been cancelled is 409 already_settled and nothing changes — the settlement is one conditional update, so a cancel racing a finish never moves the money twice.

post/marketing/exports/{id}/cancel

Request

  • Base URL: https://api.gogoscreen.com/api/v1
  • URL: https://api.gogoscreen.com/api/v1/marketing/exports/{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 an export

Changes

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