Update an assistant

Partial update — only included fields are changed. phone_number and carrier are read-only and cannot be updated via this endpoint. Cross-resource refs are validated to belong to your organization.

When introduction is included, the successful response confirms that the new opening text has been committed to the active assistant configuration used by the dashboard and by newly initialized calls. Existing localized translations are regenerated asynchronously; already initialized or in-progress calls keep the configuration they loaded earlier. A code-managed line whose greeting is owned by an enterprise line profile returns 409 Conflict.

Authorization

bearerAuth

AuthorizationBearer <token>

API key in the Authorization: Bearer <key> header. Keys are created in the SMAO dashboard (Settings → API Keys).

In: header

Path Parameters

assistant_id*string

Match^[a-f0-9]{24}$

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Partial update — include only the fields you want to change.

Properties1 <= properties

name?string

Length1 <= length <= 100

description?string

Lengthlength <= 500

language?string

Value in

"de"
"en"
"fr"
"it"
"de-CH"
"es"
"pt"
"tr"
"sv"
"fi"

voice_id?string

Voice ID. Use a value returned by GET /voices. An existing legacy ID may remain unchanged, but changing to a legacy, unknown, or unavailable ID returns 400.

company_name?string

Length1 <= length <= 200

company_industry?string

Length1 <= length <= 200

introduction?string

Replaces the canonical original opening text atomically. If language is omitted, the current original introduction language is retained; stale translations are discarded and regenerated asynchronously.

Length1 <= length <= 5000

record_call?boolean

speed?number

Voice playback rate multiplier. Some voices only support 0.8–1.2; out-of-range values for such voices return 400.

Range0.7 <= value <= 1.2

tts_style_level?number

Voice style level from 0 (calm) to 1 (expressive).

Multiple Of0.01

Range0 <= value <= 1

background_ambience?string

Background ambience bed mixed under the assistant voice during phone calls.

Value in

"clean"
"office"

interruptable?boolean

appointment_booking_enabled?boolean

contextual_asr_correction_enabled?boolean

Per-turn LLM correction of misrecognised proper nouns (names, companies, products) in caller transcripts, using the assistant's own contacts, employees, glossary and knowledge. Adds latency on turns that carry a candidate. Default false.

allow_preferred_language?boolean

whitelist?boolean

prompt_id?|

Match^[a-f0-9]{24}$

email_prompt_id?|

Match^[a-f0-9]{24}$

knowledge_group_ids?array<>

glossary_group_ids?array<>

pronunciation_group_ids?array<>

forwarding_group_ids?array<>

contact_group_ids?array<>

calendar_ids?array<>

Itemsitems <= 1

tool_ids?array<>

Webhook-type tools only. Integration-type / internal tools cannot be referenced via the public API and will return 404 on create/update.

analysis_ids?array<>

Response Body

`application/json`

curl -X PATCH "https://example.com/assistants/65f8fa6f1a9d8e0012ab34cd" \  -H "Content-Type: application/json" \  -d '{    "introduction": "Guten Tag, hier ist Sarah von Example GmbH."  }'

{  "data": {    "id": "string",    "name": "string",    "description": "string",    "language": "de",    "voice_id": "string",    "record_call": true,    "speed": 0.7,    "tts_style_level": 0,    "background_ambience": "clean",    "interruptable": true,    "appointment_booking_enabled": true,    "contextual_asr_correction_enabled": true,    "allow_preferred_language": true,    "whitelist": true,    "introduction": "string",    "company_name": "string",    "company_industry": "string",    "phone_number": "string",    "carrier": "string",    "prompt_id": "string",    "email_prompt_id": "string",    "knowledge_group_ids": [      "string"    ],    "glossary_group_ids": [      "string"    ],    "pronunciation_group_ids": [      "string"    ],    "forwarding_group_ids": [      "string"    ],    "contact_group_ids": [      "string"    ],    "calendar_ids": [      "string"    ],    "tool_ids": [      "string"    ],    "analysis_ids": [      "string"    ],    "created_at": "2019-08-24T14:15:22Z",    "updated_at": "2019-08-24T14:15:22Z"  }}

Update an assistant

Authorization

Path Parameters

Request Body

Response Body

200application/json

400application/json

401application/json

402application/json

403application/json

404application/json

409application/json

429application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`