Skip to main content
PUT
Update Phone

Headers

x-api-key
string
required

Your API key for authentication

Content-Type
enum<string>
required

Must be application/json

Available options:
application/json
x-workspace-id
string

Optional workspace ID (defaults to user's current workspace)

Path Parameters

id
string
required

The ID of the phone to update

Example:

"+17245868135"

Body

application/json
nickName
string
required

New nickname for the phone number

Response

Phone nickname successfully updated

_id
string
required

Unique ID of the phone record

Example:

"685bb187dc7279fb63ed11d"

phoneNumber
string
required

The actual phone number

Example:

"+17245868135"

userId
string

ID of the user who owns the phone

Example:

"6855d390cadc9740fe720a"

workspaceId
string

Workspace associated with this phone number

Example:

"685846b162e555e53cd3ae"

terminationUri
string

SIP termination URI

Example:

"sell-agent.pstn.twilio.com"

nickName
string

Nickname for the phone number

Example:

"production"

outboundTrunk
string

Outbound trunk identifier

Example:

"ST_B7t6CbWDG6G"

inboundTrunk
string

Inbound trunk identifier

Example:

"ST_2FKEA6i8392"

createdAt
string<date-time>

Date and time when the phone record was created

Example:

"2025-06-25T08:21:27.806Z"

updatedAt
string<date-time>

Date and time when the phone record was last updated

Example:

"2025-06-25T08:34:28.172Z"

__v
integer

Document version key

Example:

0

inboundAgentId
object

Inbound agent details

outboundAgentId
object

Outbound agent details