Skip to main content
DELETE
Detach a contact from a draft run
Removes a contact from a run that has not launched.

Draft only

Detach works while the run is a DRAFT and returns 422 after that. The reason is that launching mints a conversation per contact, and that conversation may already have been called. Removing the link afterwards would be a half-truth: the contact would vanish from the run while the record of their call, its recording and its analysis stayed behind, still carrying the run’s id. Cancel the run instead — that stops the dialling and leaves an honest record of what happened.

Basic Usage

Detaching a contact that is not on the run is a 404.

Error Scenarios

  • 404 Not Found: the run does not exist, belongs to another company, or the contact is not attached to it
  • 422 Unprocessable Entity: the run has already launched
  • 403 Forbidden: the API key does not hold write:runs

Attach Contacts

Add contacts to the run

Cancel Run

Stop a run that has already launched

Authorizations

Authorization
string
header
required

API key for authentication using Bearer scheme

Path Parameters

id
string<uuid>
required
contactId
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

Contact detached

totalContacts
number
required

Contacts remaining on the run

Example:

9