Skip to main content
POST
/
api
/
agents
/
{agent_id}
/
unassign-phone-number
/
{phone_number_id}
Unassign Phone Number
curl --request POST \
  --url https://api.example.com/api/agents/{agent_id}/unassign-phone-number/{phone_number_id}
{
  "success": true,
  "message": "Phone number unassigned successfully",
  "agent": {
    "agent_id": "agent_123",
    "assigned_phone_number_ids": []
    // ...
  }
}
Unassign a phone number from an agent.
agent_id
string
required
The unique identifier of the agent.
phone_number_id
string
required
The unique identifier of the phone number to unassign.

Response

success
boolean
Indicates if the unassignment was successful.
message
string
Success message.
agent
object
The updated agent object.
{
  "success": true,
  "message": "Phone number unassigned successfully",
  "agent": {
    "agent_id": "agent_123",
    "assigned_phone_number_ids": []
    // ...
  }
}