Update assistant

Updates an existing AI assistant. Only the fields you include in the request body are changed — omitted fields retain their current values.

Endpoint

PUT /user/assistant/{id}

Path parameters

integer

required

Unique identifier of the assistant to update.

Request

All body parameters are optional. Provide only the fields you want to update.

Core fields

string

Name of the assistant. Maximum 255 characters.

integer

Voice ID. Use the Get Voices endpoint with the mode parameter to retrieve compatible voices.

integer

Primary language ID.

string

Assistant type: inbound or outbound.

string

Engine mode: pipeline, multimodal, or dualplex.

Changing the mode resets mode-specific settings (LLM model, multimodal model, providers) to defaults for the new mode.

string

Timezone identifier (e.g., America/New_York, Europe/Bucharest).

string

Greeting message spoken at the start of a call. Maximum 200 characters.

string

System prompt defining the assistant’s behavior.

Mode-specific fields

integer

LLM model ID. Applies to pipeline mode only.

integer

Multimodal model ID. Applies to multimodal and dualplex modes.

integer

Fallback LLM for tool calls in multimodal/dualplex modes. Set to null to remove.

number

Turn detection sensitivity for multimodal/dualplex modes. Range: 0–1. Set to null for auto.

Secondary languages

integer[]

Additional language IDs. Replaces all existing secondary languages. Pass [] to remove all.

Knowledge base

integer

ID of the knowledge base to attach. Set to null to remove.

string

How the assistant uses the knowledge base: function_call or prompt.

Phone number

integer

ID of the phone number to assign. Set to null to unassign.

For inbound assistants, the number cannot be a Caller ID type and cannot be assigned to another inbound assistant.

Custom mid-call tools

integer[]

Custom mid-call tool IDs. Replaces all existing tool assignments. Pass [] to remove all tools.

Built-in tools

array

Built-in tools. Replaces all existing built-in tools. Pass [] to remove all.

Show Available tool types

call_transfer, warm_call_transfer, end_call, dtmf_input, collect_keypad, calendar_integration — See Create assistant for full field details on each type.

Voice and TTS settings

number

Voice stability. Range: 0–1.

number

Voice similarity. Range: 0–1.

number

Speech speed multiplier. Range: 0.7–1.2.

number

LLM temperature. Range: 0–1.

boolean

Whether to enable emotional TTS synthesis.

integer

Custom TTS provider ID. Set to null to use language default.

integer

Custom STT provider ID. Pipeline mode only. Set to null to use language default.

Call behavior

boolean

Whether the caller can interrupt the assistant.

Cannot be disabled for multimodal and dualplex modes.

boolean

Whether to use filler audio. Pipeline mode only.

object

Custom filler phrases per category. Replaces existing filler config.

boolean

Whether to record calls.

boolean

Whether to enable noise cancellation.

boolean

Whether the assistant waits for the customer to speak first.

Timing

integer

Maximum call duration in seconds. Range: 20–1200.

integer

Maximum silence duration before re-engagement, in seconds. Range: 1–360.

integer

Maximum silence at call start before ending, in seconds. Set to null to disable.

integer

Maximum ringing time in seconds. Range: 1–60.

Re-engagement

integer

Seconds between re-engagement attempts. Range: 7–600.

string

Custom re-engagement message prompt. Maximum 1000 characters. Set to null to use default.

Voicemail

boolean

Whether to end the call when voicemail is detected.

string

Message to leave on voicemail. Maximum 1000 characters. Set to null to disable.

Endpoint detection

string

Voice activity detection type: vad or ai.

number

Endpoint sensitivity. Range: 0–5.

number

Interrupt sensitivity. Range: 0–5.

integer

Minimum words before an interruption is processed. Range: 0–10. Set to null to disable.

Ambient sound

string

Background ambient sound: off, office, city, forest, crowded_room, cafe, or nature.

number

Ambient sound volume. Range: 0–1.

Webhook configuration

boolean

Whether webhook notifications are enabled.

string

Webhook URL for post-call notifications. Set to null to remove.

boolean

Whether webhooks are only sent for completed calls.

boolean

Whether to include the recording URL in webhook payloads.

Post-call evaluation

boolean

Whether to enable AI post-call evaluation.

array

Post-call data extraction schema. Replaces the existing schema. See Create assistant for field details.

Variables

object

Custom variables. Replaces all existing variables.

Conversation ended settings

integer

Minutes of inactivity before the conversation ends. Range: 1–1440. Set to null to disable.

boolean

Whether to allow re-triggering after inactivity ends the conversation.

string

Webhook URL for conversation ended events. Set to null to remove.

Response

string

Confirmation message.

object

Show properties

integer

Unique identifier of the assistant.

string

Name of the assistant.

string

Current status.

string

inbound or outbound.

string

Engine mode.

Example

curl -X PUT "https://portal.intellixent.ai/api/user/assistant/789" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Updated Sales Assistant",
    "initial_message": "Hello! How may I assist you?",
    "max_duration": 900
  }'

const response = await fetch('https://portal.intellixent.ai/api/user/assistant/789', {
  method: 'PUT',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: 'Updated Sales Assistant',
    initial_message: 'Hello! How may I assist you?',
    max_duration: 900
  })
});

const data = await response.json();

200 Success

{
  "message": "Assistant updated successfully",
  "data": {
    "id": 789,
    "name": "Updated Sales Assistant",
    "status": "active",
    "type": "outbound",
    "mode": "pipeline"
  }
}

404 Not found

{
  "message": "Assistant not found"
}

To remove optional fields, explicitly set them to null. To clear array fields like tool_ids or secondary_language_ids, pass an empty array [].

Overview

Assistants

Calls

Campaigns & Leads

Conversations

Messaging

Phone Numbers

Knowledge & Tools

Webhooks

Endpoint

Path parameters

Request

Core fields

Mode-specific fields

Secondary languages

Knowledge base

Phone number

Custom mid-call tools

Built-in tools

Voice and TTS settings

Call behavior

Timing

Re-engagement

Voicemail

Endpoint detection

Ambient sound

Webhook configuration

Post-call evaluation

Variables

Conversation ended settings

Response

Example

​Endpoint

​Path parameters

​Request

​Core fields

​Mode-specific fields

​Secondary languages

​Knowledge base

​Phone number

​Custom mid-call tools

​Built-in tools

​Voice and TTS settings

​Call behavior

​Timing

​Re-engagement

​Voicemail

​Endpoint detection

​Ambient sound

​Webhook configuration

​Post-call evaluation

​Variables

​Conversation ended settings

​Response

​Example

Endpoint

Path parameters

Request

Core fields

Mode-specific fields

Secondary languages

Knowledge base

Phone number

Custom mid-call tools

Built-in tools

Voice and TTS settings

Call behavior

Timing

Re-engagement

Voicemail

Endpoint detection

Ambient sound

Webhook configuration

Post-call evaluation

Variables

Conversation ended settings

Response

Example