Skip to main content
POST
/
api
/
agents
/
{agent_id}
/
assign-phone-number
curl -X POST "https://api.getbutter.ai/api/agents/agent_123/assign-phone-number?phone_number_id=pn_456" \
  -H "Authorization: Bearer <token>" \
  -H "X-Organization-Id: <org_id>"

{
  "success": true,
  "message": "Phone number assigned successfully",
  "agent": {
    "agent_id": "agent_123",
    "assigned_phone_number_ids": ["pn_456"]
    // ...
  },
  "phone_number": {
    "phone_number_id": "pn_456",
    "status": "assigned",
    "assigned_agent_id": "agent_123"
    // ...
  }
}
Assign a phone number to an agent. This enables the agent to handle inbound calls to this number.
​
agent_id
string
required
The unique identifier of the agent.
​
phone_number_id
string
required
The unique identifier of the phone number to assign.

​
Response

​
success
boolean
Indicates if the assignment was successful.
​
message
string
Success message.
​
agent
object
The updated agent object.
​
phone_number
object
The updated phone number object.
curl -X POST "https://api.getbutter.ai/api/agents/agent_123/assign-phone-number?phone_number_id=pn_456" \
  -H "Authorization: Bearer <token>" \
  -H "X-Organization-Id: <org_id>"

{
  "success": true,
  "message": "Phone number assigned successfully",
  "agent": {
    "agent_id": "agent_123",
    "assigned_phone_number_ids": ["pn_456"]
    // ...
  },
  "phone_number": {
    "phone_number_id": "pn_456",
    "status": "assigned",
    "assigned_agent_id": "agent_123"
    // ...
  }
}