Sign in

v45

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-0114775543.6 KB
Phone Numbers

Release a rented phone 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 if the number is still assigned to an agent — detach it from the agent first (PATCH /agent/{agentId} with productId: null).

post/product/release-number

Request body

productIdstring required

24-char hex MongoDB ObjectId of the phone-number product to release (the _id value returned by GET /product/phone-numbers).

Example request

{
  "productId": "6969109c84c74bed175f02a7"
}

Response

Number released

statusboolean

Example response

{
  "status": true,
  "data": {
    "success": true
  }
}