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.
POST/phone_number/release
Bearersession
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://backend.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 AuthorizationBearer <token>
Bearer token authentication. Obtain your API key from the OmniDimension dashboard.
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
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.