POST /v1/projects/{id}/platforms/operations/{operationId}/cancel
Withdraws a provision that has not been fulfilled yet. This is an operations action rather than a DELETE, because there is nothing to delete: no resource exists until the work commits. Whether it is accepted depends on the resource type — a dedicated iMessage line may sit waiting on inventory for hours and withdrawing costs nothing, while an SMS number is cancellable during inventory waiting and answers 409 once the workflow commits to its first provider order. Campaign assignment and detachment operations cannot be cancelled in any state. Wait for completion before requesting another change; that new change is not a guaranteed rollback. The output-only cancellable field is a snapshot; the cancellation transaction always checks the current phase under a row lock. A cancel that loses the race against the work finishing also answers 409: the resource exists and is billed for, so what you want then is to release it. Nothing is charged for a cancelled provision — billing runs after the work, so there is never anything to refund. Requires the platforms:write permission bound to the project resource in the path.
- TypeScript
- Python
- Rust
TypeScript
Parameters
string
required
string
required
Returns
200 The cancelled operation. Operation
boolean
required
string (date-time)
required
object
string (date-time)
OperationError
string
required
string
required
OperationReason
string
string
required
string (date-time)
OperationState
required
OperationType
required
string (date-time)
required