Update function
Partially update a function on a branch: name, description, code, parameters, or latency control. Renaming also rewrites the def name inside the code body. Returns 409 Conflict if the rename would orphan flow-step references — pass force: true in the body to rename anyway. Changes are drafts until the branch is deployed.
PATCH
/
v1
/
agents
/
{agentId}
/
branches
/
{branchId}
/
functions
/
{functionId}
Update a function
curl --request PATCH \
--url https://api.us.poly.ai/v1/agents/{agentId}/branches/{branchId}/functions/{functionId} \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"name": "<string>",
"description": "<string>",
"code": "<string>",
"parameters": [
{
"name": "<string>",
"description": "<string>"
}
],
"latencyControl": {
"enabled": false,
"randomize": false,
"initialDelay": 0,
"interval": 0,
"delayResponses": []
},
"force": true
}
'import requests
url = "https://api.us.poly.ai/v1/agents/{agentId}/branches/{branchId}/functions/{functionId}"
payload = {
"name": "<string>",
"description": "<string>",
"code": "<string>",
"parameters": [
{
"name": "<string>",
"description": "<string>"
}
],
"latencyControl": {
"enabled": False,
"randomize": False,
"initialDelay": 0,
"interval": 0,
"delayResponses": []
},
"force": True
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
code: '<string>',
parameters: [{name: '<string>', description: '<string>'}],
latencyControl: {
enabled: false,
randomize: false,
initialDelay: 0,
interval: 0,
delayResponses: []
},
force: true
})
};
fetch('https://api.us.poly.ai/v1/agents/{agentId}/branches/{branchId}/functions/{functionId}', 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://api.us.poly.ai/v1/agents/{agentId}/branches/{branchId}/functions/{functionId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'description' => '<string>',
'code' => '<string>',
'parameters' => [
[
'name' => '<string>',
'description' => '<string>'
]
],
'latencyControl' => [
'enabled' => false,
'randomize' => false,
'initialDelay' => 0,
'interval' => 0,
'delayResponses' => [
]
],
'force' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-KEY: <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://api.us.poly.ai/v1/agents/{agentId}/branches/{branchId}/functions/{functionId}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"code\": \"<string>\",\n \"parameters\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"latencyControl\": {\n \"enabled\": false,\n \"randomize\": false,\n \"initialDelay\": 0,\n \"interval\": 0,\n \"delayResponses\": []\n },\n \"force\": true\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-API-KEY", "<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.patch("https://api.us.poly.ai/v1/agents/{agentId}/branches/{branchId}/functions/{functionId}")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"code\": \"<string>\",\n \"parameters\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"latencyControl\": {\n \"enabled\": false,\n \"randomize\": false,\n \"initialDelay\": 0,\n \"interval\": 0,\n \"delayResponses\": []\n },\n \"force\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.us.poly.ai/v1/agents/{agentId}/branches/{branchId}/functions/{functionId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"code\": \"<string>\",\n \"parameters\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"latencyControl\": {\n \"enabled\": false,\n \"randomize\": false,\n \"initialDelay\": 0,\n \"interval\": 0,\n \"delayResponses\": []\n },\n \"force\": true\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"code": "<string>",
"parameters": [
{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"type": "<string>"
}
],
"errors": [
{
"lineno": 123,
"message": "<string>",
"text": "<string>"
}
],
"archived": true,
"latencyControl": {
"enabled": true,
"initialDelay": 123,
"interval": 123,
"delayResponses": [
{
"message": "<string>",
"duration": 123
}
],
"randomize": false
}
}Authorizations
Body
application/json
Response
Updated function
A custom function on a branch, including its code, parameters, and any simulated-latency configuration.
Last modified on November 4, 2026
Was this page helpful?
⌘I
Update a function
curl --request PATCH \
--url https://api.us.poly.ai/v1/agents/{agentId}/branches/{branchId}/functions/{functionId} \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"name": "<string>",
"description": "<string>",
"code": "<string>",
"parameters": [
{
"name": "<string>",
"description": "<string>"
}
],
"latencyControl": {
"enabled": false,
"randomize": false,
"initialDelay": 0,
"interval": 0,
"delayResponses": []
},
"force": true
}
'import requests
url = "https://api.us.poly.ai/v1/agents/{agentId}/branches/{branchId}/functions/{functionId}"
payload = {
"name": "<string>",
"description": "<string>",
"code": "<string>",
"parameters": [
{
"name": "<string>",
"description": "<string>"
}
],
"latencyControl": {
"enabled": False,
"randomize": False,
"initialDelay": 0,
"interval": 0,
"delayResponses": []
},
"force": True
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
code: '<string>',
parameters: [{name: '<string>', description: '<string>'}],
latencyControl: {
enabled: false,
randomize: false,
initialDelay: 0,
interval: 0,
delayResponses: []
},
force: true
})
};
fetch('https://api.us.poly.ai/v1/agents/{agentId}/branches/{branchId}/functions/{functionId}', 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://api.us.poly.ai/v1/agents/{agentId}/branches/{branchId}/functions/{functionId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'description' => '<string>',
'code' => '<string>',
'parameters' => [
[
'name' => '<string>',
'description' => '<string>'
]
],
'latencyControl' => [
'enabled' => false,
'randomize' => false,
'initialDelay' => 0,
'interval' => 0,
'delayResponses' => [
]
],
'force' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-KEY: <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://api.us.poly.ai/v1/agents/{agentId}/branches/{branchId}/functions/{functionId}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"code\": \"<string>\",\n \"parameters\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"latencyControl\": {\n \"enabled\": false,\n \"randomize\": false,\n \"initialDelay\": 0,\n \"interval\": 0,\n \"delayResponses\": []\n },\n \"force\": true\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-API-KEY", "<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.patch("https://api.us.poly.ai/v1/agents/{agentId}/branches/{branchId}/functions/{functionId}")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"code\": \"<string>\",\n \"parameters\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"latencyControl\": {\n \"enabled\": false,\n \"randomize\": false,\n \"initialDelay\": 0,\n \"interval\": 0,\n \"delayResponses\": []\n },\n \"force\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.us.poly.ai/v1/agents/{agentId}/branches/{branchId}/functions/{functionId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"code\": \"<string>\",\n \"parameters\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"latencyControl\": {\n \"enabled\": false,\n \"randomize\": false,\n \"initialDelay\": 0,\n \"interval\": 0,\n \"delayResponses\": []\n },\n \"force\": true\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"code": "<string>",
"parameters": [
{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"type": "<string>"
}
],
"errors": [
{
"lineno": 123,
"message": "<string>",
"text": "<string>"
}
],
"archived": true,
"latencyControl": {
"enabled": true,
"initialDelay": 123,
"interval": 123,
"delayResponses": [
{
"message": "<string>",
"duration": 123
}
],
"randomize": false
}
}
