Passer à la navigation

Update Receptionist

Update a receptionist’s display name, config and/or widget appearance.

Paramètres de chemin

agent_idstringRequis

En-têtes

xi-api-keystringOptionnel
xi-workspace-idstring or nullOptionnel
The customer workspace a reseller's API key acts on.

Requête

This endpoint expects an object.
configobject or nullOptionnel
Rules, procedures and transfer rules are changed through their own endpoints, not here.
namestring or nullOptionnel
widgetobject or nullOptionnel
How the website widget looks. A null label follows the receptionist's language.

Réponse

Réponse réussie

is_activebooleanLecture seule
agent_idstringOptionnelPar défaut
ID of the ElevenLabs agent behind this receptionist.
configobjectOptionnel
deactivated_at_unixinteger or nullOptionnel
Unix timestamp when this receptionist was deactivated. None when active.
deactivation_reasonenum or nullOptionnel
Why this receptionist was deactivated. None when active.
Valeurs autorisées:
namestringOptionnelPar défaut Receptionist
Display name of the receptionist.
agent_existsbooleanOptionnelPar défaut true

False when the receptionist’s underlying agent was deleted; it cannot take calls until it is set up again.

is_transfer_allowedbooleanOptionnelPar défaut false
Whether this receptionist can configure and use transfer rules.
widgetobject or nullOptionnel
How the website widget looks. Null when the agent is missing. Unset labels follow the receptionist's language.

Erreurs

422
Unprocessable Entity Error