Release phone number
Release a purchased phone number. This will:
- Disconnect any linked WhatsApp social account
- Decrement the Stripe subscription quantity (or cancel if last number)
- Release the number from Telnyx
- Mark the number as released
API key authentication - use your Zernio API key as a Bearer token
In: header
Path Parameters
Phone number record ID
Response Body
application/json
application/json
application/json
import Zernio from '@zernio/node';const zernio = new Zernio({ apiKey: process.env.ZERNIO_API_KEY });const { data } = await zernio.phonenumbers.releasePhoneNumber({ path: { id: 'abc123', },});console.log(data);{
"message": "string",
"phoneNumber": {
"id": "string",
"phoneNumber": "string",
"status": "string",
"releasedAt": "2019-08-24T14:15:22Z"
}
}{
"error": "Unauthorized"
}{
"error": "Not found"
}Purchase phone number POST
Initiate purchasing a phone number. Payment-first flow: the user does not pick a specific number. The system either creates a Stripe Checkout Session (first number) or increments the existing subscription quantity and provisions inline (subsequent numbers). Requires a paid plan. The maximum number of phone numbers is determined by the user's plan.
Resubmit a declined number POST
Submit corrected values/documents for the declined requirement(s). We PATCH them onto the SAME requirement group and re-submit it for approval; the number goes `regulatory_declined` → `pending_regulatory`. No new number and no new billing. Body shape matches the KYC submit (values / documents / address) — send only the corrected fields.