Skip to content

Update an inbound routing rule

PATCH
/voice/inbound-routing/rules/{route_id}

Partial update. Omitted fields are untouched.

is_active: false is the reversible way to take a rule out of the running. Deleting it is not.

Authorizations

Parameters

Path Parameters

route_id
required

Rule id.

integer

Rule id.

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Partial update of one rule. Omitted fields are untouched.

object
is_active
Any of:
boolean
match_conditions
Any of:
object
key
additional properties
any
name
Any of:
string
priority
Any of:
integer
queue_max_wait_seconds
Any of:
integer
ring_strategy
Any of:
string
Allowed values: single round_robin
target_id
Any of:
string
target_type
Any of:
string
Allowed values: ai_agent department extension voicemail

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