Update Receptionist

PATCH

/v1/reception/customer-facing-agents/:agent_id

PATCH

/v1/reception/customer-facing-agents/:agent_id

curl -X PATCH https://api.elevenlabs.io/v1/reception/customer-facing-agents/agent_id \
     -H "Content-Type: application/json" \
     -d '{}'

{
  "is_active": true,
  "agent_id": "",
  "config": {
    "additional_instructions": "string",
    "tone_traits": [
      "string"
    ],
    "details_to_collect": [
      "string"
    ],
    "llm": "gpt-4o-mini",
    "reasoning_effort": "none",
    "disable_rag": false,
    "background_voice_detection": true,
    "turn_eagerness": "eager",
    "voice_id": "5kMbtRSEKIkRZSdXxrZg",
    "language": "string",
    "additional_languages": [
      "string"
    ],
    "first_message": "Hello! Thanks for calling. How can I help you today?",
    "disable_first_message_interruptions": false,
    "enable_end_call_tool": true,
    "enable_skip_turn_tool": true,
    "enable_play_keypad_touch_tone_tool": false,
    "agent_rules": [
      {
        "title": "string",
        "description": "string",
        "priority": "strict",
        "id": "string",
        "created_at_unix": 1
      }
    ],
    "transfer_rules": [
      {
        "label": "string",
        "phone_number": "string",
        "condition": "string",
        "post_dial_digits": "string",
        "id": "string",
        "created_at_unix": 1
      }
    ],
    "hide_caller_number_on_transfers": false,
    "record_after_transfers": false,
    "procedures": [
      {
        "name": "string",
        "trigger": "string",
        "body": "",
        "id": "string",
        "created_at_unix": 1,
        "source_key": "string"
      }
    ],
    "enable_secure_mode": false,
    "enable_spam_protection": false
  },
  "deactivated_at_unix": 1,
  "deactivation_reason": "tier_downgrade",
  "name": "Receptionist",
  "agent_exists": true,
  "is_transfer_allowed": false,
  "widget": {
    "orb_color_1": "string",
    "orb_color_2": "string",
    "variant": "tiny",
    "placement": "top-left",
    "dismissible": true,
    "main_label": "string",
    "start_call": "string"
  }
}

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

Parametry ścieżki

agent_idstringWymagany

Żądanie

This endpoint expects an object.

configobject or nullOpcjonalny

Rules, procedures and transfer rules are changed through their own endpoints, not here.

namestring or nullOpcjonalny

Odpowiedź

Pomyślna odpowiedź

is_activebooleanTylko do odczytu

agent_idstringOpcjonalnyDomyślnie

ID of the ElevenLabs agent behind this receptionist.

configobjectOpcjonalny

deactivated_at_unixinteger or nullOpcjonalny

Unix timestamp when this receptionist was deactivated. None when active.

deactivation_reasonenum or nullOpcjonalny

Why this receptionist was deactivated. None when active.

Dozwolone wartości:

namestringOpcjonalnyDomyślnie Receptionist

Display name of the receptionist.

agent_existsbooleanOpcjonalnyDomyślnie true

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

is_transfer_allowedbooleanOpcjonalnyDomyślnie false

Whether this receptionist can configure and use transfer rules.

Błędy

422

Unprocessable Entity Error

Parametry ścieżki

Nagłówki

Żądanie

Odpowiedź

Błędy