Release a rented phone number

POST

https://api.smallest.ai/atoms/v1/product/release-number

Releases a phone number previously rented via POST /product/rent-number. The number goes back into provider inventory and recurring charges stop.

Returns 400 while the number is still in use: an agent answers on it or dials from it (“You cannot release this number because an agent answers on it or dials from it.”), a live campaign uses it, or it is an agent’s transfer number. Detach answer bindings with DELETE /agent/{agentId}/answers/{sourceId}, caller-ID bindings with DELETE /agent/{agentId}/caller-ids/{sourceId}, and clear transfer numbers via PUT /agent/{agentId}/transfer-source.

Authentication

AuthorizationBearer

API key from the console ApiKey collection, sent as Bearer token. Also accepts session cookies for browser-based auth.

Request

This endpoint expects an object.

productIdstringRequired

24-character hex id of the phone-number product to release (the id returned by GET /product/phone-numbers).

Response

Number released

statusbooleanOptional

dataobjectOptional

Errors

400

Bad Request Error

401

Unauthorized Error

500

Internal Server Error