Update Agent
Updates an existing agent’s configuration. Allows updating details, extensions, and call event hooks. Extensions and hooks can be modified or added (if ID is provided for update, null/missing for creation within the list).
curl --request PUT \
--url https://app.deepslate.eu/api/v1/vendors/{vendorId}/organizations/{organizationId}/agents/{agentId} \
--header 'Content-Type: application/json' \
--data '
{
"name": "Sales Bot Alpha V2",
"userValueTypes": {
"customer_name": "STRING",
"product_interest": "STRING",
"order_id": "NUMBER",
"zip_code": "STRING"
},
"systemPromptTemplate": "You are an expert sales assistant for ACME Corp focusing on upselling existing customers.",
"telephoneNumberId": "22334455-6677-8899-00aa-bbccddeeff11",
"llmAudioContentGenerationStrategyId": "bcdef012-3456-789a-bcde-f0123456789a",
"extensions": [
{
"type": "crm_lookup_v1",
"parameters": {
"crm_system_url": "https://updated-crm.example.com/api",
"api_key_secret": "new_secret_crm_key"
},
"id": "deadbeef-cafe-babe-feed-faceabadb001"
}
],
"callEventHooks": [
{
"type": "webhook_call_ended_v1",
"parameters": {
"target_url": "https://my.updated-service.com/call_event",
"auth_token": "bearer_xyz987"
},
"id": "b00bface-1337-badd-cafe-d00df00dcafe"
}
]
}
'import requests
url = "https://app.deepslate.eu/api/v1/vendors/{vendorId}/organizations/{organizationId}/agents/{agentId}"
payload = {
"name": "Sales Bot Alpha V2",
"userValueTypes": {
"customer_name": "STRING",
"product_interest": "STRING",
"order_id": "NUMBER",
"zip_code": "STRING"
},
"systemPromptTemplate": "You are an expert sales assistant for ACME Corp focusing on upselling existing customers.",
"telephoneNumberId": "22334455-6677-8899-00aa-bbccddeeff11",
"llmAudioContentGenerationStrategyId": "bcdef012-3456-789a-bcde-f0123456789a",
"extensions": [
{
"type": "crm_lookup_v1",
"parameters": {
"crm_system_url": "https://updated-crm.example.com/api",
"api_key_secret": "new_secret_crm_key"
},
"id": "deadbeef-cafe-babe-feed-faceabadb001"
}
],
"callEventHooks": [
{
"type": "webhook_call_ended_v1",
"parameters": {
"target_url": "https://my.updated-service.com/call_event",
"auth_token": "bearer_xyz987"
},
"id": "b00bface-1337-badd-cafe-d00df00dcafe"
}
]
}
headers = {"Content-Type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Sales Bot Alpha V2',
userValueTypes: {
customer_name: 'STRING',
product_interest: 'STRING',
order_id: 'NUMBER',
zip_code: 'STRING'
},
systemPromptTemplate: 'You are an expert sales assistant for ACME Corp focusing on upselling existing customers.',
telephoneNumberId: '22334455-6677-8899-00aa-bbccddeeff11',
llmAudioContentGenerationStrategyId: 'bcdef012-3456-789a-bcde-f0123456789a',
extensions: [
{
type: 'crm_lookup_v1',
parameters: {
crm_system_url: 'https://updated-crm.example.com/api',
api_key_secret: 'new_secret_crm_key'
},
id: 'deadbeef-cafe-babe-feed-faceabadb001'
}
],
callEventHooks: [
{
type: 'webhook_call_ended_v1',
parameters: {
target_url: 'https://my.updated-service.com/call_event',
auth_token: 'bearer_xyz987'
},
id: 'b00bface-1337-badd-cafe-d00df00dcafe'
}
]
})
};
fetch('https://app.deepslate.eu/api/v1/vendors/{vendorId}/organizations/{organizationId}/agents/{agentId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.deepslate.eu/api/v1/vendors/{vendorId}/organizations/{organizationId}/agents/{agentId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Sales Bot Alpha V2',
'userValueTypes' => [
'customer_name' => 'STRING',
'product_interest' => 'STRING',
'order_id' => 'NUMBER',
'zip_code' => 'STRING'
],
'systemPromptTemplate' => 'You are an expert sales assistant for ACME Corp focusing on upselling existing customers.',
'telephoneNumberId' => '22334455-6677-8899-00aa-bbccddeeff11',
'llmAudioContentGenerationStrategyId' => 'bcdef012-3456-789a-bcde-f0123456789a',
'extensions' => [
[
'type' => 'crm_lookup_v1',
'parameters' => [
'crm_system_url' => 'https://updated-crm.example.com/api',
'api_key_secret' => 'new_secret_crm_key'
],
'id' => 'deadbeef-cafe-babe-feed-faceabadb001'
]
],
'callEventHooks' => [
[
'type' => 'webhook_call_ended_v1',
'parameters' => [
'target_url' => 'https://my.updated-service.com/call_event',
'auth_token' => 'bearer_xyz987'
],
'id' => 'b00bface-1337-badd-cafe-d00df00dcafe'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.deepslate.eu/api/v1/vendors/{vendorId}/organizations/{organizationId}/agents/{agentId}"
payload := strings.NewReader("{\n \"name\": \"Sales Bot Alpha V2\",\n \"userValueTypes\": {\n \"customer_name\": \"STRING\",\n \"product_interest\": \"STRING\",\n \"order_id\": \"NUMBER\",\n \"zip_code\": \"STRING\"\n },\n \"systemPromptTemplate\": \"You are an expert sales assistant for ACME Corp focusing on upselling existing customers.\",\n \"telephoneNumberId\": \"22334455-6677-8899-00aa-bbccddeeff11\",\n \"llmAudioContentGenerationStrategyId\": \"bcdef012-3456-789a-bcde-f0123456789a\",\n \"extensions\": [\n {\n \"type\": \"crm_lookup_v1\",\n \"parameters\": {\n \"crm_system_url\": \"https://updated-crm.example.com/api\",\n \"api_key_secret\": \"new_secret_crm_key\"\n },\n \"id\": \"deadbeef-cafe-babe-feed-faceabadb001\"\n }\n ],\n \"callEventHooks\": [\n {\n \"type\": \"webhook_call_ended_v1\",\n \"parameters\": {\n \"target_url\": \"https://my.updated-service.com/call_event\",\n \"auth_token\": \"bearer_xyz987\"\n },\n \"id\": \"b00bface-1337-badd-cafe-d00df00dcafe\"\n }\n ]\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://app.deepslate.eu/api/v1/vendors/{vendorId}/organizations/{organizationId}/agents/{agentId}")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Sales Bot Alpha V2\",\n \"userValueTypes\": {\n \"customer_name\": \"STRING\",\n \"product_interest\": \"STRING\",\n \"order_id\": \"NUMBER\",\n \"zip_code\": \"STRING\"\n },\n \"systemPromptTemplate\": \"You are an expert sales assistant for ACME Corp focusing on upselling existing customers.\",\n \"telephoneNumberId\": \"22334455-6677-8899-00aa-bbccddeeff11\",\n \"llmAudioContentGenerationStrategyId\": \"bcdef012-3456-789a-bcde-f0123456789a\",\n \"extensions\": [\n {\n \"type\": \"crm_lookup_v1\",\n \"parameters\": {\n \"crm_system_url\": \"https://updated-crm.example.com/api\",\n \"api_key_secret\": \"new_secret_crm_key\"\n },\n \"id\": \"deadbeef-cafe-babe-feed-faceabadb001\"\n }\n ],\n \"callEventHooks\": [\n {\n \"type\": \"webhook_call_ended_v1\",\n \"parameters\": {\n \"target_url\": \"https://my.updated-service.com/call_event\",\n \"auth_token\": \"bearer_xyz987\"\n },\n \"id\": \"b00bface-1337-badd-cafe-d00df00dcafe\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.deepslate.eu/api/v1/vendors/{vendorId}/organizations/{organizationId}/agents/{agentId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Sales Bot Alpha V2\",\n \"userValueTypes\": {\n \"customer_name\": \"STRING\",\n \"product_interest\": \"STRING\",\n \"order_id\": \"NUMBER\",\n \"zip_code\": \"STRING\"\n },\n \"systemPromptTemplate\": \"You are an expert sales assistant for ACME Corp focusing on upselling existing customers.\",\n \"telephoneNumberId\": \"22334455-6677-8899-00aa-bbccddeeff11\",\n \"llmAudioContentGenerationStrategyId\": \"bcdef012-3456-789a-bcde-f0123456789a\",\n \"extensions\": [\n {\n \"type\": \"crm_lookup_v1\",\n \"parameters\": {\n \"crm_system_url\": \"https://updated-crm.example.com/api\",\n \"api_key_secret\": \"new_secret_crm_key\"\n },\n \"id\": \"deadbeef-cafe-babe-feed-faceabadb001\"\n }\n ],\n \"callEventHooks\": [\n {\n \"type\": \"webhook_call_ended_v1\",\n \"parameters\": {\n \"target_url\": \"https://my.updated-service.com/call_event\",\n \"auth_token\": \"bearer_xyz987\"\n },\n \"id\": \"b00bface-1337-badd-cafe-d00df00dcafe\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"timestamp": "2025-04-17T14:23:30Z",
"message": "<string>",
"data": null,
"traceId": "<string>"
}Path Parameters
ID of the Vendor (UUID)
ID of the Organization (UUID)
ID of the Agent to update (UUID)
Body
Agent update data
Data required to update an existing Agent.
Updated name of the agent.
"Sales Bot Alpha V2"
Updated map defining user-specific value types the agent can handle.
Show child attributes
Show child attributes
{
"customer_name": "STRING",
"product_interest": "STRING",
"order_id": "NUMBER",
"zip_code": "STRING"
}Updated template for the system prompt used by the agent's underlying LLM.
"You are an expert sales assistant for ACME Corp focusing on upselling existing customers."
Updated ID of the telephone number assigned to this agent (UUID).
"22334455-6677-8899-00aa-bbccddeeff11"
Updated ID of the LLM Audio Content Generation Strategy used by the agent (UUID).
"bcdef012-3456-789a-bcde-f0123456789a"
Updated list of LLM extensions for this agent. Include existing extension IDs (UUID) to update them, omit ID or provide null to create new ones.
Show child attributes
Show child attributes
Updated list of Call Event Hooks for this agent. Include existing hook IDs (UUID) to update them, omit ID or provide null to create new ones.
Show child attributes
Show child attributes
Response
Agent successfully updated
Standard API response wrapper
Was this page helpful?
curl --request PUT \
--url https://app.deepslate.eu/api/v1/vendors/{vendorId}/organizations/{organizationId}/agents/{agentId} \
--header 'Content-Type: application/json' \
--data '
{
"name": "Sales Bot Alpha V2",
"userValueTypes": {
"customer_name": "STRING",
"product_interest": "STRING",
"order_id": "NUMBER",
"zip_code": "STRING"
},
"systemPromptTemplate": "You are an expert sales assistant for ACME Corp focusing on upselling existing customers.",
"telephoneNumberId": "22334455-6677-8899-00aa-bbccddeeff11",
"llmAudioContentGenerationStrategyId": "bcdef012-3456-789a-bcde-f0123456789a",
"extensions": [
{
"type": "crm_lookup_v1",
"parameters": {
"crm_system_url": "https://updated-crm.example.com/api",
"api_key_secret": "new_secret_crm_key"
},
"id": "deadbeef-cafe-babe-feed-faceabadb001"
}
],
"callEventHooks": [
{
"type": "webhook_call_ended_v1",
"parameters": {
"target_url": "https://my.updated-service.com/call_event",
"auth_token": "bearer_xyz987"
},
"id": "b00bface-1337-badd-cafe-d00df00dcafe"
}
]
}
'import requests
url = "https://app.deepslate.eu/api/v1/vendors/{vendorId}/organizations/{organizationId}/agents/{agentId}"
payload = {
"name": "Sales Bot Alpha V2",
"userValueTypes": {
"customer_name": "STRING",
"product_interest": "STRING",
"order_id": "NUMBER",
"zip_code": "STRING"
},
"systemPromptTemplate": "You are an expert sales assistant for ACME Corp focusing on upselling existing customers.",
"telephoneNumberId": "22334455-6677-8899-00aa-bbccddeeff11",
"llmAudioContentGenerationStrategyId": "bcdef012-3456-789a-bcde-f0123456789a",
"extensions": [
{
"type": "crm_lookup_v1",
"parameters": {
"crm_system_url": "https://updated-crm.example.com/api",
"api_key_secret": "new_secret_crm_key"
},
"id": "deadbeef-cafe-babe-feed-faceabadb001"
}
],
"callEventHooks": [
{
"type": "webhook_call_ended_v1",
"parameters": {
"target_url": "https://my.updated-service.com/call_event",
"auth_token": "bearer_xyz987"
},
"id": "b00bface-1337-badd-cafe-d00df00dcafe"
}
]
}
headers = {"Content-Type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Sales Bot Alpha V2',
userValueTypes: {
customer_name: 'STRING',
product_interest: 'STRING',
order_id: 'NUMBER',
zip_code: 'STRING'
},
systemPromptTemplate: 'You are an expert sales assistant for ACME Corp focusing on upselling existing customers.',
telephoneNumberId: '22334455-6677-8899-00aa-bbccddeeff11',
llmAudioContentGenerationStrategyId: 'bcdef012-3456-789a-bcde-f0123456789a',
extensions: [
{
type: 'crm_lookup_v1',
parameters: {
crm_system_url: 'https://updated-crm.example.com/api',
api_key_secret: 'new_secret_crm_key'
},
id: 'deadbeef-cafe-babe-feed-faceabadb001'
}
],
callEventHooks: [
{
type: 'webhook_call_ended_v1',
parameters: {
target_url: 'https://my.updated-service.com/call_event',
auth_token: 'bearer_xyz987'
},
id: 'b00bface-1337-badd-cafe-d00df00dcafe'
}
]
})
};
fetch('https://app.deepslate.eu/api/v1/vendors/{vendorId}/organizations/{organizationId}/agents/{agentId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.deepslate.eu/api/v1/vendors/{vendorId}/organizations/{organizationId}/agents/{agentId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Sales Bot Alpha V2',
'userValueTypes' => [
'customer_name' => 'STRING',
'product_interest' => 'STRING',
'order_id' => 'NUMBER',
'zip_code' => 'STRING'
],
'systemPromptTemplate' => 'You are an expert sales assistant for ACME Corp focusing on upselling existing customers.',
'telephoneNumberId' => '22334455-6677-8899-00aa-bbccddeeff11',
'llmAudioContentGenerationStrategyId' => 'bcdef012-3456-789a-bcde-f0123456789a',
'extensions' => [
[
'type' => 'crm_lookup_v1',
'parameters' => [
'crm_system_url' => 'https://updated-crm.example.com/api',
'api_key_secret' => 'new_secret_crm_key'
],
'id' => 'deadbeef-cafe-babe-feed-faceabadb001'
]
],
'callEventHooks' => [
[
'type' => 'webhook_call_ended_v1',
'parameters' => [
'target_url' => 'https://my.updated-service.com/call_event',
'auth_token' => 'bearer_xyz987'
],
'id' => 'b00bface-1337-badd-cafe-d00df00dcafe'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.deepslate.eu/api/v1/vendors/{vendorId}/organizations/{organizationId}/agents/{agentId}"
payload := strings.NewReader("{\n \"name\": \"Sales Bot Alpha V2\",\n \"userValueTypes\": {\n \"customer_name\": \"STRING\",\n \"product_interest\": \"STRING\",\n \"order_id\": \"NUMBER\",\n \"zip_code\": \"STRING\"\n },\n \"systemPromptTemplate\": \"You are an expert sales assistant for ACME Corp focusing on upselling existing customers.\",\n \"telephoneNumberId\": \"22334455-6677-8899-00aa-bbccddeeff11\",\n \"llmAudioContentGenerationStrategyId\": \"bcdef012-3456-789a-bcde-f0123456789a\",\n \"extensions\": [\n {\n \"type\": \"crm_lookup_v1\",\n \"parameters\": {\n \"crm_system_url\": \"https://updated-crm.example.com/api\",\n \"api_key_secret\": \"new_secret_crm_key\"\n },\n \"id\": \"deadbeef-cafe-babe-feed-faceabadb001\"\n }\n ],\n \"callEventHooks\": [\n {\n \"type\": \"webhook_call_ended_v1\",\n \"parameters\": {\n \"target_url\": \"https://my.updated-service.com/call_event\",\n \"auth_token\": \"bearer_xyz987\"\n },\n \"id\": \"b00bface-1337-badd-cafe-d00df00dcafe\"\n }\n ]\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://app.deepslate.eu/api/v1/vendors/{vendorId}/organizations/{organizationId}/agents/{agentId}")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Sales Bot Alpha V2\",\n \"userValueTypes\": {\n \"customer_name\": \"STRING\",\n \"product_interest\": \"STRING\",\n \"order_id\": \"NUMBER\",\n \"zip_code\": \"STRING\"\n },\n \"systemPromptTemplate\": \"You are an expert sales assistant for ACME Corp focusing on upselling existing customers.\",\n \"telephoneNumberId\": \"22334455-6677-8899-00aa-bbccddeeff11\",\n \"llmAudioContentGenerationStrategyId\": \"bcdef012-3456-789a-bcde-f0123456789a\",\n \"extensions\": [\n {\n \"type\": \"crm_lookup_v1\",\n \"parameters\": {\n \"crm_system_url\": \"https://updated-crm.example.com/api\",\n \"api_key_secret\": \"new_secret_crm_key\"\n },\n \"id\": \"deadbeef-cafe-babe-feed-faceabadb001\"\n }\n ],\n \"callEventHooks\": [\n {\n \"type\": \"webhook_call_ended_v1\",\n \"parameters\": {\n \"target_url\": \"https://my.updated-service.com/call_event\",\n \"auth_token\": \"bearer_xyz987\"\n },\n \"id\": \"b00bface-1337-badd-cafe-d00df00dcafe\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.deepslate.eu/api/v1/vendors/{vendorId}/organizations/{organizationId}/agents/{agentId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Sales Bot Alpha V2\",\n \"userValueTypes\": {\n \"customer_name\": \"STRING\",\n \"product_interest\": \"STRING\",\n \"order_id\": \"NUMBER\",\n \"zip_code\": \"STRING\"\n },\n \"systemPromptTemplate\": \"You are an expert sales assistant for ACME Corp focusing on upselling existing customers.\",\n \"telephoneNumberId\": \"22334455-6677-8899-00aa-bbccddeeff11\",\n \"llmAudioContentGenerationStrategyId\": \"bcdef012-3456-789a-bcde-f0123456789a\",\n \"extensions\": [\n {\n \"type\": \"crm_lookup_v1\",\n \"parameters\": {\n \"crm_system_url\": \"https://updated-crm.example.com/api\",\n \"api_key_secret\": \"new_secret_crm_key\"\n },\n \"id\": \"deadbeef-cafe-babe-feed-faceabadb001\"\n }\n ],\n \"callEventHooks\": [\n {\n \"type\": \"webhook_call_ended_v1\",\n \"parameters\": {\n \"target_url\": \"https://my.updated-service.com/call_event\",\n \"auth_token\": \"bearer_xyz987\"\n },\n \"id\": \"b00bface-1337-badd-cafe-d00df00dcafe\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"timestamp": "2025-04-17T14:23:30Z",
"message": "<string>",
"data": null,
"traceId": "<string>"
}