Skip to main content
POST
json

Body

application/json
OrderId
string
required

The OrderId returned by cancel-order-request.

Example:

"JNUOID-6b1e2c4a-7d3f-4b2a-9c1e-2f5a8d9e0b11"

AuthCode
string
required

The single-use AuthCode returned by cancel-order-request. Valid for 5 minutes; not case-sensitive.

Example:

"7K4Q9M"

Response

Submission processed — OrderStatus is Complete or Failed

OrderId
string

The cancel order that was submitted.

OrderDate
string<date-time>

When the order was created (UTC). Present on Complete orders; may be absent when OrderStatus is Failed.

OrderStatus
string

Complete (numbers in NumbersChange were deactivated) or Failed (every number refused).

NumbersChange
object[]

Numbers the carrier deactivated. Now Cancelled - Pending Delete.

FailedChange
object[]

Numbers the carrier refused, or that were already cancelled. These stay Active.