Unassign Phone Number from Agent
Unassign a phone number from an agent's call flow. This removes the assignment and automatically cleans up associated SIP trunking.
POST
The number stays in your workspace, with no agent or call flow, until you assign it again. To give the number up entirely, use Release Phone Number.
Requires the agent:edit permission.
Path Parameters
agentIdstringrequiredThe ID of the agent whose phone number will be released.
phoneNumberIdstringrequiredThe _id of the phone number to unassign. It must currently be assigned to this agent.
Headers
x-workspace-idstringrequiredWorkspace identifier for the API. Required to scope the release operation.
Request Body
No request body is read. If you send Content-Type: application/json, send {} as the body.
Response
200 with the updated agent, in the same shape as Get Call Agent except that phoneNumberIds holds IDs, not objects.
Errors
| Status | Body | When |
|---|---|---|
400 | {"error": "Workspace ID is required"} | No x-workspace-id |
403 | {"error": "Insufficient permissions"} | Your role doesn't have agent:edit |
500 | {"error": "..."} | Anything else |
{
"_id": "d5d5d5d5d5d5d5d5d5d5d5d5",
"workspaceId": "d1d1d1d1d1d1d1d1d1d1d1d1",
"name": "Customer Support Agent",
"ttsModel": {
"provider": "rime",
"voiceId": "mistv3_wildflower",
"name": "Wildflower",
"language": "en",
"rimeModel": "mistv3"
},
"llmModel": "platform-llm",
"type": "voice",
"status": "ready",
"phoneNumberIds": [],
"activeSessions": [],
"createdAt": "2026-10-29T10:00:00.000Z",
"updatedAt": "2026-10-29T12:00:00.000Z"
}Last updated on