Live Exports

Cancel a run

Stop an in-flight run. A run that already finished returns the run_not_active conflict.

post/v1/live-export/runs/{id}/cancel

Request

  • Base URL: https://api.whalesync.com
  • URL: https://api.whalesync.com/v1/live-export/runs/{id}/cancel
  • Auth: HTTP bearer

Path parameters

idstring required
Example:run_8f3kq0vz.2mv91xk

Response

The run, now cancelling or cancelled.

idstring required
status'pending' | 'running' | 'completed' | 'failed' | 'cancelled' required
trigger'manual' | 'schedule' required

Whether a person/API started it, or the cadence did.

started_atstring date-time nullable required
finished_atstring date-time nullable required
summarystring nullable required

The one-line story: what the run is doing right now, or how it ended.

warningstring nullable required

Set when the run completed but a step finished with a warning.

errorstring nullable required

The rolled-up error for a failed run.

app_urlstring uri required

The run in the Whalesync app, for a person who wants to watch or share it — like every app_url, nothing here needs their attention.

live_export_idstring required

The Live Export this run belongs to.

urlstring uri required

Example response

{
  "id": "run_8f3kq0vz.2mv91xk",
  "live_export_id": "lex_8f3kq0vz",
  "steps": [
    {
      "name": "Pull Contacts"
    }
  ]
}

Changes

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