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

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.

With auto-renew off, the number is never charged again. It keeps working until the end of the period already paid for, and is released within a few hours after that. About 48 hours before, the account owner gets an email saying the number will be released, and another once it is.

Turn it back on any time before that date and the number renews as normal. Once released, the number is gone. Every new purchase starts with auto-renew on, including buying back a number you let go.

More in Buy a number over the API.

POST/phone_number/auto_renew
Body
3 fields
·

The number to switch.

false stops renewal, true turns it back on. Must be a JSON boolean: a string such as "false", a number, or a missing value is refused.

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/auto_renew' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "phone_number": "+15551234567",
  "auto_renew": false
}'
Example response
{
  "success": true,
  "phone_number": "+15551234567",
  "auto_renew": false
}

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 switch.

auto_renew*boolean

false stops renewal, true turns it back on. Must be a JSON boolean: a string such as "false", a number, or a missing value is refused.

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 switch is set.

application/json
success?boolean
phone_number?string
auto_renew?boolean

The value the number now has.

Was this page helpful?

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.

Attach phone number to agent

Attach a phone number to an existing agent. Without user_id, use any number and agent your key can manage. With user_id, the number and the agent must both belong to that client.