Skip to main content
PATCH
Keep a number set to be released

Authorizations

Authorization
string
header
required

Enter your API key (Bearer token)

Path Parameters

id
string
required

Phone number id (UUID).

Body

application/json
release_at
enum<string> | null
required

null cancels a scheduled release, so the number stays.

Available options:
null

Response

agent_id
string | null
required
created_at
string
required
currency
string | null
required
failure
object | null
required

Why a failed purchase failed. Null unless status is failed.

id
string
required

Stable from the first response: the purchase id becomes the number id.

imported
boolean
required
managed_by_plan
boolean
required

Part of an Agent Phone Plan: give it up by cancelling the plan.

monthly_price
number | null
required
phone_number
string
required
refunded
boolean
required

A failed purchase whose payment was refunded in full.

release_at
string | null
required

When a releasing number goes away. PATCH release_at null to keep it.

revision
string | null
required
status
enum<string>
required

released only answers the release of an imported number, which is removed at once.

Available options:
provisioning,
active,
releasing,
failed,
released
next_action
object
try_it
object

Ways to hear the agent on this number, as on agent writes.

warnings
object[]