---
title: "Cancel a pool virtual number you own"
method: POST
path: "/cancel-number/"
tags: ["Numbers"]
---

# Cancel a pool virtual number you own

`POST /cancel-number/`

## Request

- Base URL: `http://api.smsfusion.com.au`
- URL: `http://api.smsfusion.com.au/cancel-number/`
- Auth: one of:
  - API key in query parameter `key`
  - HTTP basic

Immediately cancels an active pool number owned by your account and returns it to the pool. No refund for the remaining period. Pool numbers only - a legacy third-party-provider number must be cancelled from the web Numbers page. If the number was bought with a callback URL, that URL receives a final form POST with event=cancelled and msisdn

## Query parameters

- `key` string, required

## Response `200`

Number cancelled and returned to the pool

- object
  - `success` boolean
  - `msisdn` string
  - `status` string
  - `callback` boolean

## Other responses

- `400`: BAD_REQUEST - the number is not a platform pool number
- `401`: Authentication failed or required field 'num' empty
- `404`: NOT_FOUND - no active number with that msisdn on your account
- `405`: Method not allowed - POST only

---

[API](https://skmtc.dev/smsfusion/apis/sms-fusion-api.md) · [All operations](https://skmtc.dev/smsfusion/apis/sms-fusion-api/llms.txt) · [OpenAPI document](https://skmtc.dev/smsfusion/apis/sms-fusion-api/revisions/a88b2793a6e9?raw)