Skip to main content
PUT
Attach or detach the outbound caller number of a phone agent
Requires the phone:write scope. The number must be verified for the same workspace as the agent. Use caller_number: null to clear it. This action clears the agent’s number pool selection and keeps its assigned SIP trunk. To choose a BYOC pool or a different SIP trunk, open the agent’s Telephony & Routing → Outbound Caller setting. See agent configuration.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

phone_agent_id
string
required

Body

application/json
caller_number
string | null
required

A phone number verified for your organization (E.164), or null to detach the caller id

Minimum string length: 1

Response

Default Response

phone_agent_id
string
required
caller_number
string | null
required