Update Assistant

PUT

api

vendors

{vendorId}

organizations

{organizationId}

assistants

{assistantId}

Update Assistant

curl --request PUT \
  --url https://app.phonebot.io:80/api/v1/vendors/{vendorId}/organizations/{organizationId}/assistants/{assistantId} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Help Desk Assistant v2",
  "systemPrompt": "You are an expert support assistant for ACME Gadgets Pro series. Prioritize Pro customer issues.",
  "systemPromptGreeting": "Welcome back! How can I assist you today?",
  "llmAudioContentGenerationStrategyId": "bcdef012-3456-789a-bcde-f0123456789a",
  "extensions": [
    {
      "type": "kb_search_v2",
      "parameters": {
        "kb_url": "https://new-kb.example.com/api",
        "max_results": 5
      },
      "id": "deadbeef-cafe-babe-feed-faceabadb001"
    }
  ],
  "callEventHooks": [
    {
      "type": "webhook_transcript_ready_v1",
      "parameters": {
        "target_url": "https://my.updated.service/transcript",
        "secret_key": "n3w_s3cr3t"
      },
      "id": "b00bface-1337-badd-cafe-d00df00dcafe"
    }
  ],
  "telephoneNumberId": "22334455-6677-8899-00aa-bbccddeeff11"
}
'

{
  "success": true,
  "timestamp": "2025-04-17T14:23:30Z",
  "message": "<string>",
  "data": null,
  "traceId": "<string>"
}

Path Parameters

vendorId

string

required

ID of the Vendor (UUID)

organizationId

string

required

ID of the Organization (UUID)

assistantId

string

required

ID of the Assistant to update (UUID)

Body

application/json

Assistant update data

Data required to update an existing Assistant.

name

string

required

Updated name of the assistant.

Example:

"Help Desk Assistant v2"

systemPrompt

string

required

Updated main system prompt defining the assistant's role and behavior.

Example:

"You are an expert support assistant for ACME Gadgets Pro series. Prioritize Pro customer issues."

systemPromptGreeting

string

required

Updated initial greeting message from the assistant.

Example:

"Welcome back! How can I assist you today?"

llmAudioContentGenerationStrategyId

string

required

Updated ID of the LLM Audio Content Generation Strategy used by the assistant (UUID).

Example:

"bcdef012-3456-789a-bcde-f0123456789a"

extensions

object[]

required

Updated list of LLM extensions for this assistant. Include existing extension IDs (UUID) to update them, omit ID or provide null to create new ones.

Show child attributes

extensions.type

string

required

Type identifier for the LLM extension. Required for both create and update.

Example:

"kb_search_v2"

extensions.parameters

object

required

Specific parameters for this extension instance. Required for both create and update.

Show child attributes

extensions.parameters.{key}

object

Example:

{
  "kb_url": "https://new-kb.example.com/api",
  "max_results": 5
}

extensions.id

string

Unique identifier (UUID) of the LLM extension instance to update. If null or missing, a new extension is created.

Example:

"deadbeef-cafe-babe-feed-faceabadb001"

callEventHooks

object[]

required

Updated list of Call Event Hooks for this assistant. Include existing hook IDs (UUID) to update them, omit ID or provide null to create new ones.

Show child attributes

callEventHooks.type

string

required

Type identifier for the call event hook. Required for both create and update.

Example:

"webhook_transcript_ready_v1"

callEventHooks.parameters

object

required

Specific parameters for this hook instance. Required for both create and update.

Show child attributes

callEventHooks.parameters.{key}

string

Example:

{
  "target_url": "https://my.updated.service/transcript",
  "secret_key": "n3w_s3cr3t"
}

callEventHooks.id

string

Unique identifier (UUID) of the call event hook instance to update. If null or missing, a new hook is created.

Example:

"b00bface-1337-badd-cafe-d00df00dcafe"

telephoneNumberId

string

Updated ID of the telephone number assigned to this assistant (UUID).

Example:

"22334455-6677-8899-00aa-bbccddeeff11"

Response

Assistant successfully updated

Standard API response wrapper

success

boolean

required

Indicates if the request was successful

Example:

true

timestamp

string<date-time>

required

Response timestamp in ISO-8601 format

Example:

"2025-04-17T14:23:30Z"

message

string

Human-readable message

data

any

Payload data object

Example:

null

traceId

string

Correlation or trace ID

Delete AssistantDeletes a specific assistant.

⌘I

Update Assistant

curl --request PUT \
  --url https://app.phonebot.io:80/api/v1/vendors/{vendorId}/organizations/{organizationId}/assistants/{assistantId} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Help Desk Assistant v2",
  "systemPrompt": "You are an expert support assistant for ACME Gadgets Pro series. Prioritize Pro customer issues.",
  "systemPromptGreeting": "Welcome back! How can I assist you today?",
  "llmAudioContentGenerationStrategyId": "bcdef012-3456-789a-bcde-f0123456789a",
  "extensions": [
    {
      "type": "kb_search_v2",
      "parameters": {
        "kb_url": "https://new-kb.example.com/api",
        "max_results": 5
      },
      "id": "deadbeef-cafe-babe-feed-faceabadb001"
    }
  ],
  "callEventHooks": [
    {
      "type": "webhook_transcript_ready_v1",
      "parameters": {
        "target_url": "https://my.updated.service/transcript",
        "secret_key": "n3w_s3cr3t"
      },
      "id": "b00bface-1337-badd-cafe-d00df00dcafe"
    }
  ],
  "telephoneNumberId": "22334455-6677-8899-00aa-bbccddeeff11"
}
'

{
  "success": true,
  "timestamp": "2025-04-17T14:23:30Z",
  "message": "<string>",
  "data": null,
  "traceId": "<string>"
}

Overview

Realtime

Assistants

Agents

Agent Tasks

Organizations

Plans

Vendors

Path Parameters

Body

Response