Telephone Number

Cancel and archive reservation object

Cancel a dynamic number order. Only orders in the status "ON_HOLD" or "REJECTED" can be cancelled, and there's nothing you can do to facilitate this for an order which is "IN_PROGRESS". Only the inbound carrier can decide to hold or reject an IN_PROGRESS order.<span hidden><br/><br/> See <a href="dynamicInventory.html#cancelAndRemoveDynamicInventoryReservation">here</a> for more information.</span>

post/v2/partition/{partitionId}/account/{accountId}/telephonenumber/tn-requests/actions/cancel

Request

Base URL
https://api.alianza.com
Auth
API key in header X-AUTH-TOKEN
TypeScript
https://skmtc.dev/alianza/apis/alianza-public-api/docs/v2/partition/:partitionId/account/:accountId/telephonenumber/tn-requests/actions/cancel/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

accountIdstring required

ID of account. Refers to <a href="#/~schema/DynamicTelephoneNumberActivationX">dynamicTelephoneNumberActivation.accountId</a>, which refers to <a href="#/~schema/Account">account.id</a>

partitionIdstring required

ID of partition. Refers to <a href="#/~schema/DynamicTelephoneNumberActivationX">dynamicTelephoneNumberActivation.partitionId</a>, which refers to <a href="#/~schema/PartitionX">partition.id</a>

Request body

referenceIdstring

partitionIdstring

accountIdstring

Response

Successful operation

Changes

No recorded changes to this operation across all 1 revision of this API.