marketing.exports.cancel

Stop an export

POST/marketing/exports/{id}/cancel

Operation: marketing.exports.cancel
MCP tool: marketing_exports_cancel

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.

curl -X POST "https://api.gogoscreen.com/api/v1/marketing/exports/<id>/cancel" \
  -H "Authorization: Bearer $GOGOSCREEN_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"

A request to this operation.

At a glance

Fact	Detail
Scopes	`marketing:export`
Credentials	a signed in dashboard session or an API key.
Rate limit	120 requests a minute per credential, in the `write` class.
Idempotency	Required. Send an `Idempotency-Key` header; a retry with the same key and the same body returns the stored answer with `Idempotent-Replayed: true`. How idempotency works.
MCP tool	`marketing_exports_cancel`
Always sets	`Cache-Control: private, no-store`
Verified email	Required. An account whose email address is not verified meets `403 email_unverified` before the operation runs.
Marketing videos	Required. An account without marketing videos enabled meets `403 feature_disabled` before the operation runs.

Path parameters

Name	Type	Required	Description
id	string	Required	The resource `id`, from a create answer or the matching list.format: uuid

Response

Answers 200. Every answer also carries RateLimit-Limit, RateLimit-Remaining and RateLimit-Reset, and every error body carries a requestId.

200 OK

Stop an export

Name Type Description

export object

22 fields inside export

Name	Type	Description
audioMode	string
durationSeconds	number
failureCode	string \| null
format	string
hasCaptions	boolean
hasCover	boolean
hasTranscript	boolean
id	string
progress	object \| null	The last progress reading while the export runs: the current step and a whole percent. null once it has settled, and null when no reading was recorded.
at	string \| null
percent	integer	0–100
stage	string
projectId	string
qa	object \| null	The outcome of the automated checks, once they have run; null before. Why an export failed is `failureCode`.
notes	string[]	What the export did that a person may want to know, as codes: `font_missing`, `cover_drawn`, `cover_not_drawn`, `narration_fitted`, `transcript_written`, `transcript_not_written`. A note is not a failure.
ok	boolean	Whether the automated checks on the finished file passed.
revisionId	string
secondsCharged	number \| null
secondsReserved	number
state	string	one of: queued, running, succeeded, failed, cancelled
status	string
watermark	string

resource object

35 fields inside resource

Name Type Description

artifactsExpired boolean The work succeeded but its files were deleted at the end of the retention period.

cancellable boolean

cost object

secondsCharged number | null

secondsReserved number

watermark boolean

createdAt string | null format: date-time

error object | null

code string

reason string | null

retryable boolean

terminal boolean

expiresAt string | null format: date-time

finishedAt string | null format: date-time

id string

idempotencyKey string | null

internalStatus string A finer-grained status word. Informational; branch on state.

pollAfterMs number | null Wait this long before polling again; null once the state is terminal.

progress object | null HOW FAR THE WORK HAS GOT, as last reported, or null — null while nothing has been recorded yet and null for every terminal state, because a finished job is 100 by definition and a failed one has no bar to draw.

at string | null When it was reported. A reading that has stopped moving means the work has, not that the bar is broken.

percent number 0 to 100, as last reported for this job. It never goes backwards. Draw exactly this number: nothing here is interpolated and a client that animates between readings is inventing progress.

stage string A short label for the current step. Show it; do not branch on it.

requestId string | null

result object | null

7 fields inside result

Name	Type	Description
artifacts	object[]
bytes	number \| null
expiresAt	string \| null	format: date-time
sha256	string \| null
type	string
url	string \| null
durationSeconds	number \| null

stage string | null

startedAt string | null format: date-time

state string The five public states. Poll until one of succeeded/failed/cancelled.one of: queued, running, succeeded, failed, cancelled

200 OK headers
Header	Meaning
`Cache-Control`	Always `private, no-store`.
`Idempotent-Replayed`	Present only when this answer was stored by an earlier call with the same Idempotency-Key. Nothing new was done.

Errors

Every refusal is { error: { code, message, details?, requestId } }. Branch on code, never on the sentence. The full catalogue is at Errors.

Code	Status	When it happens	What to do
expected_revision_required	400	A save arrived without `expectedRevisionId`, so it could have landed on words the caller never saw.	Read the project, send its current revision id as `expectedRevisionId`, and handle `revision_conflict` when somebody else saved first.
idempotency_key_required	400	A mutating operation arrived over HTTP with no `Idempotency-Key` header. It is refused before the body is parsed, so a caller missing both learns about both at once.	Add an `Idempotency-Key` header of up to 128 characters, unique to this request. Over MCP the same value goes in the `idempotencyKey` tool argument.
invalid_cover_text	400	The cover words are not valid for this design at this shape, usually because they do not fit.	Shorten the cover text, or choose a format with more room.
unknown_template	400	The marketing design named does not exist.	Read `GET /catalog/marketing/templates` and send an id it lists.
unsupported_audio_mode	400	The design does not offer that audio mode.	`details.audioModes` lists what it does offer. Pick one of those.
unsupported_duration	400	The design does not offer that length.	`details.durations` lists what it does offer. Pick one of those.
unsupported_format	400	The design does not offer that shape.	`details.formats` lists what it does offer. Pick one of those.
validation_failed	400	The merged path, query and body did not match the operation's schema. The schemas are strict, so an unknown field is a failure rather than something ignored, and a string carrying half of a character is refused before it can be stored.	Read `details.issues`. Each entry carries a `path`, a `message` and a machine readable `code`. Fix every named field and send the request again; the same body always fails the same way.
unauthorized	401	No credential was presented, or the key is unknown, revoked or expired, or an `X-API-Key` header carried something that is not an API key. `details.reason` says which.	Send `Authorization: Bearer gsk_live_…`. A revoked or expired key never starts working again, so issue a new one in the developer console. Put a dashboard session token in `Authorization`, never in `X-API-Key`.
insufficient_seconds	402	The account's seconds wallet does not hold enough time for the video that was asked for. It is the only refusal on this surface that is a 402.	`details.needed` and `details.available` are the two numbers. Buy more time, or ask for a shorter video. Retrying without changing either fails the same way.
forbidden_scope	403	The credential does not carry every scope the operation declares, or it is the wrong kind of credential for it. `keys.` and `assistant.` are user only and can never be called by a key.	`details.requiredScopes` and `details.missingScopes` name what is missing. A key's scopes cannot be changed after it is issued, so create a new key with them. When `details.allowedActors` is present, no key can call this operation at all.
not_found	404	No resource of that id belongs to this account. A resource that belongs to somebody else answers 404 as well, never 403.	Check the id. Do not treat this as a permissions problem.
already_settled	409	A cancel arrived for an export that had already succeeded, failed or been cancelled. The settlement is one conditional update, so a cancel racing a finish never moves the money twice.	Read the resource and take its current `state` as the answer. Nothing changed.
conflict	409	The request conflicts with the state the resource is in, and no more specific code applies.	Re-read the resource and decide from its current state. Retrying the same request unchanged will not help.
idempotency_conflict	409	That idempotency key has already been used on this operation with a different request body.	Use a fresh key for a different request. A key stands for one intent, not for one attempt.
idempotency_in_progress	409	The first request under that key is still being worked. Two concurrent identical requests both reach the store and one of them is told this.	Wait the `Retry-After` seconds, which is 2, and send exactly the same request again with the same key. Do not change the body and do not mint a new key.
no_revision	409	An export was asked for on a project that has no revision yet.	Create a revision first, or wait for the generation that is making one to finish.
revision_configuration_mismatch	409	The export asks for a shape, length or audio mode that is not the revision's own.	Export the revision as it stands, or save a new revision at the configuration you want and export that.
revision_conflict	409	`expectedRevisionId` is no longer the project's current revision, so somebody else saved first. Nothing was written.	`details.currentRevisionId` is the revision that won. Re-read the project, rebase the change on it, and save again.
too_many_in_flight	409	The account already has as many renders or exports running as it may. The default ceiling is three of each.	`details.limit` and `details.inFlight` carry the numbers. Wait for one to settle, or cancel one, then retry.
source_expired	410	The website source is past its retention window.	Scan the site again. Projects already built from it keep the version they were built from.
campaign_speed_breaks_music_ending	422	At the revision's saved playback speed the music would no longer end with the film.	`details.missing` says what to put right. Save a new revision at a speed the music bed can end on, then export that.
campaign_speed_breaks_narration_fit	422	At the revision's saved playback speed a spoken line would no longer fit the shot it belongs to.	`details.missing` says what to put right. Shorten the line or save the revision at a slower speed, then export that.
campaign_speed_not_offered	422	The revision is saved at a playback speed this build does not deliver, and the export judges the saved speed again before it reserves anything.	`details.speed` is the saved speed and `details.missing` names the one way out, which is saving the revision at a speed the build offers. Save a new revision, then export that.
rate_limited	429	The credential's per minute budget, the account's per minute ceiling, or a daily cap was exceeded. `details.scope` is `minute`, `day` or `account`, or `global` when the product's own daily cap on voice previews is spent.	Wait the `Retry-After` seconds and retry. `details.limit` and `details.resetAt` say what was hit and when it reopens. The `RateLimit-*` headers on every answer let a client pace itself before it gets here.
internal_error	500	An unhandled failure inside this API. The original message is logged and never answered.	Retry once, then quote `requestId` to support. A 5xx deletes the idempotency claim rather than storing it, so retrying under the same key is safe.
queue_unavailable	503	The work could not be started because a service it needs was briefly unavailable.	Back off and retry. Nothing was created and nothing was charged.
reservation_failed	503	The seconds wallet could not hold the time for an export.	Back off and retry. Nothing was reserved, so no time is stranded.