TextKitDocs

Cancel a run in progress

The run stays readable, ended with end_reason canceled.

DELETE/v1/automations/{id}/runs/{run_id}

Path Parameters

  • idstringrequired
  • run_idstringrequired

Details

409 if it is advancing at this moment.

Responses

  • 200AutomationRun

    Canceled run

  • 401Error

    Missing, malformed, or revoked API key

  • 402Error

    Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged

  • 429Error

    Rate limit or quota exceeded

Response Fields

  • idstring

    Example: run_1790000000000a1B2c3D4.

  • objectautomation_run
  • automation_idstring
  • automation_versioninteger
  • statusrunning, waiting, completed, failed
  • tostring
  • user_idstring

    Nullable.

  • testboolean
  • trigger_eventstring
  • stepinteger

    Index of the step the run is on.

  • waiting_untilstring (date-time)

    Nullable.

  • waiting_for_eventstring

    Nullable.

  • end_reasonfinished, end_step, branch_end, opted_out, flow_deleted, version_removed, expired, canceled, error, null

    Nullable.

  • messages_sentinteger
  • messages_failedinteger
  • timelinearray of object
  • timeline[].atstring (date-time)
  • timeline[].typestarted, sent, send_failed, send_unconfirmed, send_skipped, wait_started, wait_done, waiting_for_event, event_received, timed_out, condition_met, condition_not_met, ended
  • timeline[].step_idstring
  • timeline[].detailstring
  • timeline[].message_idstring
  • started_atstring (date-time)
  • ended_atstring (date-time)

    Nullable.

Errors

Every error has the same JSON shape, and request_id matches the X-Request-Id response header. Errors lists every code and what to do about it.

  • 401

    Missing, malformed, or revoked API key

  • 402

    Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged

  • 429

    Rate limit or quota exceeded