Skip to main content
DELETE
Delete run
Soft-deletes a run that is no longer active.

Only when the run is inert

An active run has queued calls that a delete would orphan. The alternative — letting DELETE cascade a cancel — was deliberately rejected: it makes an HTTP verb silently terminate live phone calls, which is not something a delete should do by implication. Cancel first; that is the operation whose job is stopping the dialling.

What happens to everything else

Deleting a run removes the grouping, not the history.

Error Scenarios

  • 404 Not Found: the run does not exist, belongs to another company, or is already deleted
  • 422 Unprocessable Entity: the run is still active
  • 403 Forbidden: the API key does not hold delete:runs

Cancel Run

Make an active run inert first

List Run Conversations

Read the results before you delete

Authorizations

Authorization
string
header
required

API key for authentication using Bearer scheme

Path Parameters

id
string<uuid>
required

Query Parameters

companyId
string

Required for ATS API keys to specify which company to access. Ignored for standard company API keys.

Response

Run deleted

id
string<uuid>
required

Id of the deleted resource

deleted
enum<boolean>
required

Always true; a failed delete answers with an error status

Available options:
true
Example:

true