Phone numbers

Release a rented phone number

View as Markdown

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

Returns 400 if the number is still assigned to an agent — detach it from the agent first (PATCH /agent/{agentId} with productId: null).

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-char hex MongoDB ObjectId of the phone-number product to release (the _id value returned by GET /product/phone-numbers).

Response

Number released
statusboolean
dataobject

Errors

400
Bad Request Error
401
Unauthorized Error
500
Internal Server Error