Skip to main content
PUT
Change a number's verification

Authorizations

Authorization
string
header
required

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

Kallabot-Version
enum<string>

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.

Available options:
2026-11-07
Example:

"2026-11-07"

Path Parameters

number_id
string
required

Body

application/json
bundle_id
string
required
Pattern: ^[0-9a-fA-F-]{36}$
address_sid
string | null
Pattern: ^AD[0-9a-f]{32}$

Response

Successful Response

id
string
required

The number id.

e164
string
required

The number in E.164 form.

label
string
required

Its label (the number itself when unlabelled).

source
enum<string>
required

Bought or moved in here, or on your own carrier.

Available options:
kallabot,
sip
origin
string
required

kallabot, ported, ops or byoc.

status
string
required

The stored status: provisioning, active, suspended, releasing, failed.

state
enum<string>
required

What it means for callers.

Available options:
live,
getting_ready,
releasing,
not_answering,
failed
state_detail
string
required

The state in plain words.

capabilities
NumberCapabilities · object
required
can_call_out
boolean
required

Agents can call out from it.

settings
LineRouting · object
required

How calls to it are answered.

country_code
string | null

ISO 3166 alpha-2.

number_type
string | null

The number type.

connection_name
string | null

Your SIP connection's name, for a number on one.

failure
string | null

Why a purchase failed, in plain words.

agent
LineAgent · object | null

Who answers it.

route_id
string | null

The current route; send as expected_route_id.

bundle
LineBundle · object | null

The verification it uses.

bought_at
string | null

ISO 8601 time it was added.