Skip to main content
POST
Cancel a number transfer

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

Idempotency-Key
string
required

A unique key (a UUID works) for this request. Retrying with the same key returns the first answer instead of running twice.

Maximum string length: 255
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

port_in_id
string
required

Response

Successful Response

id
string
required

The transfer id.

status
string
required

Where the transfer stands.

assisted
boolean
required

Our team runs it with your carrier (outside the US).

provider
string
required

The carrier receiving the numbers.

numbers
PortInNumber · object[]
required

The numbers and their status.

created_at
string
required

ISO 8601.

updated_at
string
required

ISO 8601.

provider_port_sid
string | null

The carrier's reference.

losing_carrier
string | null

The carrier the numbers leave.

target_date
string | null

The date asked for (YYYY-MM-DD).

status_detail
string | null

The status in plain words.

failure_reason
string | null

Why it failed.

ported_at
string | null

When the numbers arrived.