Update Assistant

Update an assistant’s configuration. If published, changes auto-sync to the voice engine.

Endpoint

PATCH /v1/assistants/{assistant_id}

assistant_id

string

required

Assistant ID or UUID

Request Body

All fields are optional — only include what you want to change. Every field accepted by Create Assistant can be updated:

Field	Type	Description
`name`	string	Assistant name
`description`	string	Assistant description
`system_prompt`	string	System instructions
`model`	object	LLM configuration (provider, model, temperature, max_tokens)
`voice`	object	Voice configuration (provider, voice_id, language)
`transcriber`	object	Transcriber configuration (provider, model, language)
`first_message`	string	Opening greeting
`first_message_mode`	string	`assistant-speaks-first`, `assistant-waits-for-user`, `user-speaks-first`
`max_duration_seconds`	number	Max call duration in seconds
`silence_timeout_seconds`	number	Inactivity timeout in seconds
`background_sound`	string	`office`, `off`, or a custom URL
`background_sound_volume`	number	0.0–1.0
`audio_recording_enabled`	boolean	Enable audio recording
`summary_enabled`	boolean	Enable post-call summary
`analysis_enabled`	boolean	Enable post-call analysis
`analysis_profile_id`	integer or null	Organization analysis profile ID
`analysis_plan`	object	Summary / structured data / success evaluation plan
`artifact_plan`	object	Artifact generation plan
`start_speaking_plan`	object	Start speaking plan
`stop_speaking_plan`	object	Stop speaking plan
`monitor_plan`	object	Monitoring plan
`compliance_plan`	object	Compliance controls — see Create Assistant for the full structure and validation rules
`avatar_behavior_profile`	object	Avatar behavior controls
`background_speech_denoising_plan`	object	Denoising configuration
`keypad_input_plan`	object	Keypad input handling
`observability_plan`	object	Observability plan
`transport_configurations`	array	Transport provider configs
`credentials`	array	Inline dynamic credentials
`credential_ids`	array	Vapi credential UUIDs
`hooks`	array	Event hooks
`server`	object	Assistant callback config (url, timeout, secret)
`client_messages`	array	Client SDK messages
`server_messages`	array	Server URL messages
`metadata_json`	object	Custom metadata
`squad_id`	string	Squad UUID
`squad_role`	string	`primary`, `fallback`, `specialist`
`file_ids`	array	Knowledge-base file UUIDs
`tool_ids`	array	Tool IDs
`data_collection`	object	Structured data collection config — see Create Assistant

compliance_plan is validated on update: recording_consent.max_attempts must be 1–3, recording_consent.end_call_on_decline must be a boolean, transcript_retention.enabled must be a boolean, and sensitive_data.custom_patterns may contain at most 10 patterns of 200 characters.

Example Request

Nested provider, vocabulary, fallback, voice-behavior, speaking-plan, analysis, and compliance shapes are the same as Create Assistant. An update replaces each included top-level object; send the complete desired model, voice, transcriber, or plan object rather than relying on a partial nested merge.

Switch to Custom Provider (Spitch)

curl -X PATCH https://api.vonative.com/v1/assistants/a1b2c3d4-e5f6-7890-abcd-ef1234567890 \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "voice": {
      "provider": "spitch",
      "voice_id": "lina",
      "language": "yo"
    },
    "transcriber": {
      "provider": "spitch",
      "language": "yo"
    }
  }'

Add Credential Reference

curl -X PATCH https://api.vonative.com/v1/assistants/a1b2c3d4-e5f6-7890-abcd-ef1234567890 \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "credential_ids": [
      "vapi-cred-uuid-1111"
    ]
  }'

Set Custom Webhook URL

curl -X PATCH https://api.vonative.com/v1/assistants/a1b2c3d4-e5f6-7890-abcd-ef1234567890 \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "server": {
      "url": "https://myapp.com/call-events",
      "timeout": 10,
      "secret": "my-hmac-secret"
    }
  }'

Include the wanted server_messages (for example, end-of-call-report) to receive assistant callbacks. This is separate from organization webhook subscriptions; see Webhook event contracts.

Enable Compliance & Data Collection

curl -X PATCH https://api.vonative.com/v1/assistants/a1b2c3d4-e5f6-7890-abcd-ef1234567890 \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "compliance_plan": {
      "enabled": true,
      "ai_disclosure": { "enabled": true },
      "recording_consent": { "enabled": true, "end_call_on_decline": true },
      "transcript_retention": { "enabled": false },
      "sensitive_data": { "enabled": true }
    },
    "data_collection": {
      "enabled": true,
      "mode": "task_group",
      "collections": [
        { "name": "email", "type": "email", "required": true }
      ]
    }
  }'

Response

{
  "success": true,
  "data": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "name": "Updated Bot Name",
    "compliance_plan": {
      "enabled": true,
      "ai_disclosure": { "enabled": true, "message": "You are speaking with an AI assistant." },
      "recording_consent": { "enabled": true, "max_attempts": 2, "end_call_on_decline": true },
      "transcript_retention": { "enabled": false },
      "sensitive_data": { "enabled": true, "custom_patterns": [] }
    },
    "data_collection": {
      "enabled": true,
      "mode": "task_group",
      "collections": [
        { "name": "email", "type": "email", "required": true }
      ]
    },
    "status": "published",
    "updated_at": "2025-01-15T11:00:00Z"
  }
}

If the assistant is published, the update is automatically synced to the voice engine. No need to re-publish.

Authentication

Introduction

Assistants

Phone Numbers

Workflows

Calls

Meets

Files

Tools

Server Credentials

Sessions

Call Logs

Webhooks

Campaigns

Update Assistant

Update Assistant

Endpoint

Request Body

Example Request

Switch to Custom Provider (Spitch)

Add Credential Reference

Set Custom Webhook URL

Enable Compliance & Data Collection

Response

​Update Assistant

​Endpoint

​Request Body

​Example Request

​Switch to Custom Provider (Spitch)

​Add Credential Reference

​Set Custom Webhook URL

​Enable Compliance & Data Collection

​Response

Update Assistant

Endpoint

Request Body

Example Request

Switch to Custom Provider (Spitch)

Add Credential Reference

Set Custom Webhook URL

Enable Compliance & Data Collection

Response