Rename a number
Changes the number’s label.
Scopes: number:write
Authorizations
An API key from Settings → API keys, sent as Authorization: Bearer kb_live_…. A workspace key starts kb_; a personal key starts kbp_ and acts as its owner.
Headers
The API version to answer as, a date (YYYY-MM-DD). Leave it out for the current version (2026-11-07). An unknown version is refused with 400 unsupported_api_version.
2026-11-07 "2026-11-07"
Path Parameters
Body
80Response
Successful Response
The number id.
The number in E.164 form.
Its label (the number itself when unlabelled).
Bought or moved in here, or on your own carrier.
kallabot, sip kallabot, ported, ops or byoc.
The stored status: provisioning, active, suspended, releasing, failed.
What it means for callers.
live, getting_ready, releasing, not_answering, failed The state in plain words.
Agents can call out from it.
How calls to it are answered.
ISO 3166 alpha-2.
The number type.
Your SIP connection's name, for a number on one.
Why a purchase failed, in plain words.
Who answers it.
The current route; send as expected_route_id.
The verification it uses.
ISO 8601 time it was added.