Skip to main content
POST
Cancel process

Authorizations

Authorization
string
header
default:PHONEFARM_API_KEY
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

process_id
string<uuid>
required

Body

application/json
reason
string
required
Minimum string length: 1
requested_by
object
required
strategy
enum<string>
default:soft_then_force
Available options:
soft,
hard,
soft_then_force
force_after_seconds
integer
default:10
Required range: x >= 0

Response

Cancellation request result.

status
enum<string>
required
Available options:
cancel_requested,
cancelled,
cancelled_with_partial_work,
ignored_terminal
process
object
required
cancelled_queue_item_ids
string[]
active_queue_item_ids
string[]
active_target
object | null
termination
object