Skip to main content
PATCH
/
phone-numbers
/
{id}
Update phone number configuration
curl --request PATCH \
  --url https://api.helloannie.com/v1/phone-numbers/{id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "language": "ENGLISH",
  "verifiedCallerId": "<string>",
  "callbackForwardingNumber": "<string>",
  "voiceId": "FRIENDLY_BRIGHT"
}
'
{
  "success": true,
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "orgId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "botId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "number": "<string>",
    "name": "<string>",
    "language": "ENGLISH",
    "outbound": true,
    "verifiedCallerId": "<string>",
    "callbackForwardingNumber": "<string>",
    "voiceId": "FRIENDLY_BRIGHT",
    "speed": 123,
    "stability": 123,
    "similarity": 123,
    "style": 123
  }
}

Path Parameters

​
phoneNumberId
string<uuid>
required

The ID of the phone number to update

Body

Payload to update phone number configuration. Only provided fields will be updated.

​
language
enum<string>

The language of the phone number

Available options:
ENGLISH,
SPANISH,
FRENCH
​
verifiedCallerId
string | null
​
callbackForwardingNumber
string | null

If a recipient calls back an outbound number, the call will be forwarded to this phone number. Note: This field will be ignored for inbound numbers and only applied to outbound numbers.

​
voiceId
enum<string>

The voice of the phone number

Available options:
FRIENDLY_BRIGHT,
CALM_REASSURING,
POLISHED_PROFESSIONAL,
KIND_CURIOUS,
CONFIDENT_UPBEAT

Response

Response returned after updating phone number configuration

​
success
enum<boolean>
required
Available options:
true
​
data
object
required

Represents a Twilio phone number and its configuration