Skip to content

Turn the receptionist on or off

PATCH
/voice/agents/receptionist

Enable or disable the receptionist without deleting it.

Disabling stops it answering; its configuration, knowledge and history survive. This is the switch to use for “stop answering right now” - deleting the agent is not reversible.

Authorizations

Parameters

Query Parameters

enabled
required

Explicit, not a toggle: a retried request is idempotent instead of flipping the receptionist back on.

boolean

Explicit, not a toggle: a retried request is idempotent instead of flipping the receptionist back on.

Header Parameters

X-Target-Org-Id
Any of:
string

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