Skip to main content
PATCH
Update a phone number's inbox, agent, or metadata

Authorizations

Authorization
string
header
required

Dairo API key, e.g. dairo_test_... or dairo_live_...

Path Parameters

id
string<uuid>
required

Body

application/json

At least one property is required. An explicit null unbinds.

inboxId
string<uuid> | null
agentId
string<uuid> | null
metadata
object

Response

Success

object
string
required
Allowed value: "phone_number"
id
string<uuid>
required
phoneNumber
string
required

E.164.

countryCode
string
required
numberType
enum<string>
required
Available options:
local,
toll_free,
national,
mobile
status
enum<string>
required

pending means the provider reserved the number but regulatory documents are still outstanding (common for German local numbers). It is not an error.

Available options:
pending,
active,
releasing,
released,
failed
createdAt
string<date-time>
required
capabilities
string[]
inboxId
string<uuid> | null

When set, inbound SMS to this number lands in that inbox.

agentId
string<uuid> | null
monthlyCostUsd
number | null
setupCostUsd
number | null
requirements
object

Outstanding regulatory requirements, when status is pending.

metadata
object
purchasedAt
string<date-time> | null
releasedAt
string<date-time> | null