Agents

Update agent settings

Update agent configuration settings including call transfer, multilingual support, webhooks, and more

put/agents/{agentId}/settings

Request

  • Base URL: https://api.telvana.com
  • URL: https://api.telvana.com/agents/{agentId}/settings
  • Auth: API key in header x-api-key

Path parameters

agentIdstring required
Example:jm1u1cawc7dka1x84mrjvb4y

Unique identifier for the agent

Request body

inboundSinglePrompt'null' nullable

null stops using the inbound single prompt (set in the portal), leaving inboundPrompt and inboundVoicePrompt as they are

hasCallTransferboolean

Enable/disable call transfer

hasEndCallboolean

Enable/disable end call tool

transferCallerId'human' | 'agent'

Caller ID shown on transfer: "human" (caller number) or "agent" (business number)

hasAutoInboundTransferboolean

Enable/disable auto inbound transfer

inboundTransferNumberstring nullable

Phone number for auto inbound transfer

isMultilingualboolean

Enable/disable multilingual support

hasBargeInboolean

Enable/disable barge-in (interruption)

hasPostConversationWebhookboolean

Enable/disable post-conversation webhook

postConversationWebhookUrlstring nullable

URL for post-conversation webhook

hasHintsboolean

Enable/disable speech recognition hints

hintsstring nullable

Speech recognition hints (comma-separated)

hasLanguageboolean

Enable/disable custom language

languagestring nullable

Language code (e.g., en-US)

voiceIdstring nullable

Voice ID for TTS

personaNamestring nullable

Spoken name of the assistant for GPT-Live voices, e.g. "Marin"

businessNamestring nullable

Business name as it should be spoken; defaults to the workspace name

inboundGreetingstring nullable

Exact opening line for inbound calls on GPT-Live voices

voiceScopestring nullable

One to three sentences on what this agent helps with

voiceTone'calm' | 'warm' | 'professional' nullable

Speaking tone preset for GPT-Live voices

aiDisclosurestring nullable

What the assistant says when asked whether it is an AI

inboundVoicePromptstring nullable

Optional hand-written prompt for the GPT-Live voice model on inbound calls, opening line included; the full prompt still drives the backend. Empty or null clears it

integrationIdsstring[]

Array of integration IDs

disabledToolNamesstring[]

Array of disabled workspace tool names

Response

Agent settings updated successfully

messagestring

Example response

{
  "data": {
    "id": "jm1u1cawc7dka1x84mrjvb4y",
    "hasCallTransfer": true,
    "hasEndCall": true,
    "hasBargeIn": true,
    "language": "en-US"
  },
  "message": "Agent settings updated successfully"
}

Changes

No recorded changes to this operation across all 1 revision of this API.