Skip to content

Set org-wide inbound call defaults

POST
/voice/agents/global-settings

Replace the org’s inbound defaults.

A REPLACE, not a merge: voice writes the whole settings row, so a field left out is a field cleared. Read the current values first.

POST rather than PUT because that is the verb voice exposes, and a second spelling for the same operation is worse than an imperfect one.

org_id is stripped from the body and set from the key.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

inbound_default_agent_name, inbound_default_timezone and inbound_default_event_id are the settings; contacts is a JSON STRING, not a list - voice stores it as text.

object
key
additional properties
any

Responses

200

Successful Response

object
data
required

One voice object - a collection, an agent, a route, a chat.

Open-shaped: voice adds fields to these bodies on its own release cadence and a dropped-or-added key must not be a 500 in this service.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string