Skip to main content
POST
/
settings
/
phone
Add/Update Phone Number
curl --request POST \
  --url https://api.getoutbox.ai/settings/phone \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "phone_number",
  "integration": "twilio",
  "friendly_name": "<string>",
  "phone_number": "<string>",
  "phone_number_id": "<string>",
  "inbound_cost": 0,
  "outbound_cost": 0,
  "charge_per_second": false,
  "rebill_on": false,
  "sip_uri": "<string>",
  "sip_username": "<string>",
  "sip_password": "<string>"
}
'

Authorizations

​
Authorization
string
header
required

Company API Key

Body

application/json

Phone number details

​
type
enum<string>
required
Available options:
phone_number,
verified_caller_id
​
integration
enum<string>
required
Available options:
twilio,
vonage,
telnyx,
sip
​
friendly_name
string
required
​
phone_number
string
required
​
phone_number_id
string

For updates only

​
inbound_cost
number
default:0
​
outbound_cost
number
default:0
​
charge_per_second
boolean
default:false
​
rebill_on
boolean
default:false
​
sip_uri
string

Required for SIP integration

​
sip_username
string

Required for SIP integration

​
sip_password
string

Required for SIP integration

Response

Phone number added/updated successfully