Update Agent
Update supported setup fields for an accessible agent.
POST
/
update-agent
Update agent's setup
curl --request POST \
--url https://app.phonely.ai/api/update-agent \
--header 'Content-Type: application/json' \
--header 'X-Authorization: <api-key>' \
--data '
{
"uid": "<string>",
"agentId": "<string>",
"orgId": "<string>",
"voiceId": "<string>",
"agentName": "<string>",
"greetingMessage": "<string>",
"humanizeConversation": true
}
'import requests
url = "https://app.phonely.ai/api/update-agent"
payload = {
"uid": "<string>",
"agentId": "<string>",
"orgId": "<string>",
"voiceId": "<string>",
"agentName": "<string>",
"greetingMessage": "<string>",
"humanizeConversation": True
}
headers = {
"X-Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Authorization': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
uid: '<string>',
agentId: '<string>',
orgId: '<string>',
voiceId: '<string>',
agentName: '<string>',
greetingMessage: '<string>',
humanizeConversation: true
})
};
fetch('https://app.phonely.ai/api/update-agent', 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.phonely.ai/api/update-agent",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'uid' => '<string>',
'agentId' => '<string>',
'orgId' => '<string>',
'voiceId' => '<string>',
'agentName' => '<string>',
'greetingMessage' => '<string>',
'humanizeConversation' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Authorization: <api-key>"
],
]);
$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.phonely.ai/api/update-agent"
payload := strings.NewReader("{\n \"uid\": \"<string>\",\n \"agentId\": \"<string>\",\n \"orgId\": \"<string>\",\n \"voiceId\": \"<string>\",\n \"agentName\": \"<string>\",\n \"greetingMessage\": \"<string>\",\n \"humanizeConversation\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Authorization", "<api-key>")
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.post("https://app.phonely.ai/api/update-agent")
.header("X-Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"uid\": \"<string>\",\n \"agentId\": \"<string>\",\n \"orgId\": \"<string>\",\n \"voiceId\": \"<string>\",\n \"agentName\": \"<string>\",\n \"greetingMessage\": \"<string>\",\n \"humanizeConversation\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.phonely.ai/api/update-agent")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"uid\": \"<string>\",\n \"agentId\": \"<string>\",\n \"orgId\": \"<string>\",\n \"voiceId\": \"<string>\",\n \"agentName\": \"<string>\",\n \"greetingMessage\": \"<string>\",\n \"humanizeConversation\": true\n}"
response = http.request(request)
puts response.read_body{
"success": true
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}Updates supported agent setup fields. The API key must belong to the supplied user, and that user must have access to the agent.
When updating
orgId, the destination organization must be accessible to the user. Voice IDs and conversation styles are validated before the update is applied.Authorizations
Body
application/json
User ID
Agent ID to update
Organization ID to update
ID of the voice to assign to the agent
Name of the agent, limited to 50 characters
Maximum string length:
50Greeting message to be used when the agent is called, limited to 500 characters
Maximum string length:
500Set to true to add natural vocal fillers to the conversation
Conversation style
Available options:
Casual, Humorous, Direct, Formal, Persuasive, Friendly Response
Agent updated successfully
Indicates if the update was successful
Last modified on August 10, 2026
⌘I
Update agent's setup
curl --request POST \
--url https://app.phonely.ai/api/update-agent \
--header 'Content-Type: application/json' \
--header 'X-Authorization: <api-key>' \
--data '
{
"uid": "<string>",
"agentId": "<string>",
"orgId": "<string>",
"voiceId": "<string>",
"agentName": "<string>",
"greetingMessage": "<string>",
"humanizeConversation": true
}
'import requests
url = "https://app.phonely.ai/api/update-agent"
payload = {
"uid": "<string>",
"agentId": "<string>",
"orgId": "<string>",
"voiceId": "<string>",
"agentName": "<string>",
"greetingMessage": "<string>",
"humanizeConversation": True
}
headers = {
"X-Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Authorization': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
uid: '<string>',
agentId: '<string>',
orgId: '<string>',
voiceId: '<string>',
agentName: '<string>',
greetingMessage: '<string>',
humanizeConversation: true
})
};
fetch('https://app.phonely.ai/api/update-agent', 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.phonely.ai/api/update-agent",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'uid' => '<string>',
'agentId' => '<string>',
'orgId' => '<string>',
'voiceId' => '<string>',
'agentName' => '<string>',
'greetingMessage' => '<string>',
'humanizeConversation' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Authorization: <api-key>"
],
]);
$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.phonely.ai/api/update-agent"
payload := strings.NewReader("{\n \"uid\": \"<string>\",\n \"agentId\": \"<string>\",\n \"orgId\": \"<string>\",\n \"voiceId\": \"<string>\",\n \"agentName\": \"<string>\",\n \"greetingMessage\": \"<string>\",\n \"humanizeConversation\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Authorization", "<api-key>")
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.post("https://app.phonely.ai/api/update-agent")
.header("X-Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"uid\": \"<string>\",\n \"agentId\": \"<string>\",\n \"orgId\": \"<string>\",\n \"voiceId\": \"<string>\",\n \"agentName\": \"<string>\",\n \"greetingMessage\": \"<string>\",\n \"humanizeConversation\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.phonely.ai/api/update-agent")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"uid\": \"<string>\",\n \"agentId\": \"<string>\",\n \"orgId\": \"<string>\",\n \"voiceId\": \"<string>\",\n \"agentName\": \"<string>\",\n \"greetingMessage\": \"<string>\",\n \"humanizeConversation\": true\n}"
response = http.request(request)
puts response.read_body{
"success": true
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}
