MCP is live.Set upAsk the community
OmniDimension
Dashboard
DocumentationAPI referenceSDKsMCP
Phone numbers

Release a phone number

Give up a phone number and stop its rental, so it is not charged at the next renewal. Only a number currently allocated to the account can be released.

Releasing gives the number up and stops its rental, so it is not charged at the next renewal.

More in Buy a number over the API.

POST/phone_number/release
Body
2 fields
·

The number to release.

Reseller accounts only: the client to act on. Omit it to act on your own account.

curl -X POST 'https://omnidim.io/api/v1/phone_number/release' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "phone_number": "+15551234567"
}'
Example response
{
  "success": true,
  "phone_number": "+15551234567",
  "status": "released"
}

Authorization

BearerAuth
headerAuthorizationBearer <token>

Bearer token authentication. Obtain your API key from the OmniDimension dashboard.

Request Body

application/json
phone_number*string

The number to release.

user_id?integer

Reseller accounts only: the client to act on. Omit it to act on your own account.

Response body

application/json

Response Body

The number was released.

application/json
success?boolean
phone_number?string
status?"released"
Value in"released"

Was this page helpful?

Purchase a phone number

Buy a phone number from the OmniDimension number shop. The monthly rental comes out of your wallet and the number is added to your account, ready to attach to an agent.

Switch auto-renew on a phone number

Turn auto-renew off or back on for a number bought from the number shop. With auto-renew off, the number is not charged again: it keeps working until the end of the period already paid for and is then released. Turn it back on before that date and it renews as normal. Sending the value the number already has changes nothing and still succeeds.