APIPhone NumbersUpdate Phone Number
Update Phone Number
Assign an agent to a phone number (or send agentId as null to unassign it) and set its fallback number. Assigning an agent also updates carrier and LiveKit routing so inbound calls reach that agent. The agent must belong to your organization. Returns the updated phone number; warnings lists any routing steps that did not complete.
Created: September 16, 2026
Updated: September 16, 2026
Overview
PUT
https://dashboard.vinsi.ai/api/phone-numbers/{phoneNumberId}
Request
Headers
Content-Typestring
x-api-keystring
Params
phoneNumberIdstring
Example: phn_1757964000123_k2j4h5g6f
Request Body
{2 items
"agentId":string"cmexampleagent000000000001"
"fallbackNumber":string"+15555550100"
}
Response
{32 items
"id":string"phn_1757964000123_k2j4h5g6f"
"phoneNumber":string"+15555550199"
"friendlyName":string"Main Line"
"providerId":string"2468013579246801357"
"provider":string"telnyx"
"capabilities":string"{"voice":true,"sms":true}"
"agentId":string"cmexampleagent000000000001"
"fallbackNumber":string"+15555550100"
"isActive":booltrue
"userId":string"cmexampleuser0000000000001"
"organizationId":string"cmexampleorg00000000000001"
"createdAt":string"2026-09-01T18:00:00.000Z"
"updatedAt":string"2026-09-10T21:14:00.000Z"
"SIPUserName":null
"SIPPassword":null
"SIPTerminationURI":null
"livekitTrunkConfigured":booltrue
"trunkName":string"Main Line"
"livekitTrunkId":string"ST_exampleTrunk01"
"livekitOutboundTrunkId":null
"livekitOutboundConfigured":null
"stripeSubscriptionId":null
"routingMode":string"agent"
"routingDeskPhoneId":null
"voicemailEnabled":boolfalse
"voicemailPin":null
"huntGroupId":null
"queueId":null
"queuePriority":null
"livekitCluster":string"vinsi-do"
"agent":{4 items
"id":string"cmexampleagent000000000001"
"name":string"Front Desk Agent"
"isAfterHoursFallback":boolfalse
"routeOutboundVia":string"telnyx"
}
"warnings":[]0 items
}
Endpoint Explorer
Note: You must be already authenticated on https://dashboard.vinsi.ai/ to use this API tester.
PUT
Headers
Content-Type: *
x-api-key: *
Params
phoneNumberId: *
Response
No response yet. Click Send to test the API.