PUT
/
phone_numbers
/
{id}
Update Phone Number
curl --request PUT \
  --url https://api.vogent.ai/api/phone_numbers/{id} \
  --header 'Content-Type: application/json' \
  --data '{
  "agentId": "<string>"
}'
{
  "id": "<string>",
  "number": "+18001234567",
  "type": "PSTN",
  "agentId": "<string>"
}

Path Parameters

id
string
required

ID of the versioned prompt.

Body

application/json

Update phone number properties

agentId
string

The ID of the agent to link this phone number to. Set to the empty string to unlink an agent.

Response

Successful operation

id
string
required
number
string
required

The number in e.164 format, or the SIP username, if the type is SIP_USERNAME.

Example:

"+18001234567"

type
enum<string>
required
Available options:
PSTN,
SIP_USERNAME
agentId
string | null
required

The ID of the linked agent, if the phone number is linked to one.