1. Assistants
  • Assistants
    • List all assistants
      GET
    • Create a new assistant
      POST
    • Get an assistant
      GET
    • Update an assistant
      PATCH
    • Delete an assistant
      DELETE
  • Tool Templates
    • List all tool templates
      GET
    • Create a new tool template
      POST
    • Get a tool template
      GET
    • Update a tool template
      PATCH
    • Delete a tool template
      DELETE
  • Numbers
    • List all phone numbers
      GET
    • Register a phone number
      POST
    • Get a phone number
      GET
    • Update a phone number
      PATCH
    • Delete a phone number
      DELETE
  • Calls
    • List calls
      GET
    • Get call by ID
      GET
    • Initiate outbound call
      POST
  • Call Control
    • Send control command to active call
      POST
  • Usage
    • Get usage logs
      GET
  • SIP Trunks
    • List SIP trunks
      GET
    • Create a SIP trunk
      POST
    • Get a SIP trunk
      GET
    • Delete a SIP trunk
      DELETE
  • Voices
    • List available voices
  • BYOK
    • Get BYOK configurations
    • Add BYOK configuration
    • Delete BYOK configuration
    • Get BYOK provider configurations
  • Domains
    • Get your domain
    • Add a domain
    • Delete your domain
    • List available Resend domains
    • Select and sync a Resend domain
    • Verify domain DNS records
    • Refresh domain status
  • Webhooks
    • Dynamic assistant configuration webhook
    • Tool/Function Call
    • Call Status Update
    • End of Call Report
  • Analysis Templates
    • List analysis templates
    • Create analysis template
    • Get analysis template
    • Update analysis template
    • Delete analysis template
  • Organization
    • Get organization information
    • Create organization
    • Get organization information (deprecated)
  • Campaigns
    • List all campaigns
    • Create a campaign
    • Get a campaign
    • Update a campaign
    • Delete a campaign
    • List campaign leads
    • Add a lead
    • Remove a lead
  • Agents (Deprecated)
    • List all agents
    • Create a new agent
    • Get an agent
    • Update an agent
    • Delete an agent
  • System
    • Health check
  • Chats
    • Append a chat message
    • List chat messages
    • Delete a chat message
    • Get conversation context for a contact
  • Schemas
    • Error
    • Pagination
    • UUID
    • Timestamp
    • SuccessResponse
    • STTConfig
    • LLMConfig
    • TTSConfig
    • Agent
    • XAIRealtimeConfig
    • AgentCreate
    • AgentUpdate
    • PhoneNumber
    • PhoneNumberCreate
    • PhoneNumberUpdate
    • Call
    • CallControlCommand
    • InjectContextCommand
    • SayCommand
    • EndCallCommand
    • TransferCommand
    • CallControlResponse
    • OutboundCallRequest
    • UsageLog
    • OutboundCallResponse
    • Organization
    • UsageSummary
    • SipTrunk
    • SipTrunkCreate
    • OrganizationChild
    • OrganizationCreate
    • Voice
    • OrganizationCreated
    • CallObject
    • AssistantRequestPayload
    • Customer
    • AssistantRequestResponse
    • XAIRealtimeVoice
    • AssistantConfigOverride
    • AnalysisPlan
    • AssistantWebhookObject
    • ToolCallsPayload
    • ToolCall
    • ToolCallsResponse
    • StatusUpdatePayload
    • EndOfCallReportPayload
    • ToolDefinition
    • EndCallTool
    • TransferCallTool
    • WebhookHeaders
    • XAIRealtimeWebhookNotes
    • ToolFunctionConfig
    • ToolTransferConfig
    • ToolTemplate
    • ToolTemplateCreate
    • ToolTemplateUpdate
    • AnalysisTemplate
    • CreateAnalysisTemplate
    • UpdateAnalysisTemplate
    • AnalysisTemplateListResponse
    • CampaignLead
    • Campaign
    • CampaignCreate
    • CampaignUpdate
    • CampaignLeadCreate
    • ChatMessage
    • ChatMessageCreate
    • ChatContext
Book a meeting
Linkedin
Github
📄 Documentation🔌 API Reference
🤖 MCP🕐 Changelog📦 SDK🟢 Status
📄 Documentation🔌 API Reference
🤖 MCP🕐 Changelog📦 SDK🟢 Status
  1. Assistants

Update an assistant

PATCH
https://api.hmsovereign.com/api/v1/assistants/{id}
Assistants
Last modified:2026-04-23 10:43:17
Maintainer:Not configured
Update an existing assistant. Only provided fields will be updated.

Request

Authorization
Bearer Token
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
or
Path Params

Body Params application/jsonRequired

Examples

Responses

🟢200
application/json
Assistant updated successfully
Body

Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PATCH 'https://api.hmsovereign.com/api/v1/assistants/' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "string",
    "business_name": "string",
    "notification_email": "user@example.com",
    "first_message": "string",
    "is_active": true,
    "max_duration_seconds": 1,
    "autonomous_silence_handling": true,
    "silence_timeout_seconds": 1,
    "voicemail_detection": true,
    "voicemail_message": "string",
    "gdpr_mode": true,
    "webhook_url": "http://example.com",
    "webhook_secret": "string",
    "webhook_events": [
        "string"
    ],
    "stt_config": {
        "provider": "deepgram",
        "model": "nova-3-general",
        "language": "multi",
        "keyterms": [
            "yes",
            "no",
            "okay",
            "Acme"
        ],
        "tag_audio_events": true,
        "include_timestamps": false,
        "sample_rate": 16000,
        "languages": [
            "nl",
            "en"
        ],
        "code_switching": true,
        "region": "eu-west",
        "endpointing": 0.05,
        "custom_vocabulary": [
            "HMS Sovereign",
            "Flireo"
        ],
        "translation_enabled": false,
        "translation_target_languages": [
            "en"
        ]
    },
    "llm_config": {
        "provider": "openai",
        "model": "gpt-5.4",
        "voice": "ara",
        "vertexai": false,
        "location": "europe-west4",
        "analysis_model": "gemini-2.5-flash-lite",
        "temperature": 0.7,
        "messages": [
            {
                "role": "system",
                "content": "string"
            }
        ],
        "tools": [
            {
                "name": "lookup_contact",
                "description": "Look up contact information by name or phone number",
                "url": "https://n8n.example.com/webhook/contacts",
                "async": false,
                "parameters": {
                    "type": "object",
                    "properties": {
                        "query": {
                            "type": "string",
                            "description": "Name or phone number to search"
                        }
                    },
                    "required": [
                        "query"
                    ]
                }
            }
        ]
    },
    "tts_config": {
        "provider": "elevenlabs",
        "voice_id": "ukiwGs47sHyibruHJ1vg",
        "model": "eleven_flash_v2_5",
        "language": "nl",
        "stability": 0.5,
        "similarity_boost": 0.75,
        "use_speaker_boost": true,
        "speed": 1,
        "style": 0,
        "instructions": "Speak in a friendly and engaging tone."
    }
}'
Response Response Example
{
    "assistant": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "Customer Support Agent",
        "business_name": "Acme Corp",
        "notification_email": "support@acme.com",
        "first_message": "Hello, welcome to Acme. How can I help you today?",
        "is_active": true,
        "max_duration_seconds": 300,
        "autonomous_silence_handling": false,
        "silence_timeout_seconds": 8,
        "voicemail_detection": false,
        "voicemail_message": "Hello, this is Acme Corp. We will call you back at a later time. Thank you!",
        "gdpr_mode": false,
        "webhook_url": "http://example.com",
        "webhook_secret": "string",
        "webhook_events": [
            "string"
        ],
        "analysis_plan": {
            "structured_data_plan": {
                "enabled": true,
                "schema": {
                    "type": "object",
                    "properties": {
                        "intent": {
                            "type": "string"
                        },
                        "sentiment": {
                            "type": "string",
                            "enum": [
                                "positive",
                                "neutral",
                                "negative"
                            ]
                        },
                        "appointment_booked": {
                            "type": "boolean"
                        }
                    }
                },
                "messages": [
                    {
                        "role": "system",
                        "content": "Analyze the following call transcript according to this schema: {{schema}}"
                    }
                ]
            },
            "min_messages_threshold": 2
        },
        "stt_config": {
            "provider": "deepgram",
            "model": "nova-3-general",
            "language": "multi",
            "keyterms": [
                "yes",
                "no",
                "okay",
                "Acme"
            ],
            "tag_audio_events": true,
            "include_timestamps": false,
            "sample_rate": 16000,
            "languages": [
                "nl",
                "en"
            ],
            "code_switching": true,
            "region": "eu-west",
            "endpointing": 0.05,
            "custom_vocabulary": [
                "HMS Sovereign",
                "Flireo"
            ],
            "translation_enabled": false,
            "translation_target_languages": [
                "en"
            ]
        },
        "llm_config": {
            "provider": "openai",
            "model": "gpt-5.4",
            "voice": "ara",
            "vertexai": false,
            "location": "europe-west4",
            "analysis_model": "gemini-2.5-flash-lite",
            "temperature": 0.7,
            "messages": [
                {
                    "role": "system",
                    "content": "string"
                }
            ],
            "tools": [
                {
                    "name": "lookup_contact",
                    "description": "Look up contact information by name or phone number",
                    "url": "https://n8n.example.com/webhook/contacts",
                    "async": false,
                    "parameters": {
                        "type": "object",
                        "properties": {
                            "query": {
                                "type": "string",
                                "description": "Name or phone number to search"
                            }
                        },
                        "required": [
                            "query"
                        ]
                    }
                }
            ]
        },
        "tts_config": {
            "provider": "elevenlabs",
            "voice_id": "ukiwGs47sHyibruHJ1vg",
            "model": "eleven_flash_v2_5",
            "language": "nl",
            "stability": 0.5,
            "similarity_boost": 0.75,
            "use_speaker_boost": true,
            "speed": 1,
            "style": 0,
            "instructions": "Speak in a friendly and engaging tone."
        },
        "created_at": "2019-08-24T14:15:22.123Z",
        "updated_at": "2019-08-24T14:15:22.123Z"
    }
}
Modified at 2026-04-23 10:43:17
Previous
Get an assistant
Next
Delete an assistant
Built with