Update agent
Updates agent configuration. All fields are optional - only provided fields are changed.
For companyInfo and persona, provided fields are merged into the existing object (not replaced).
curl -X PATCH "https://api.sendkit.ai/v1/agents/example_string" \
-H "Content-Type: application/json" \
-H "X-Api-Key: YOUR_API_KEY" \
-d '{
"name": "Enterprise Sales Agent v2"
}'
import requests
import json
url = "https://api.sendkit.ai/v1/agents/example_string"
headers = {
"Content-Type": "application/json",
"X-Api-Key": "YOUR_API_KEY"
}
data = {
"name": "Enterprise Sales Agent v2"
}
response = requests.patch(url, headers=headers, json=data)
print(response.json())
const response = await fetch("https://api.sendkit.ai/v1/agents/example_string", {
method: "PATCH",
headers: {
"Content-Type": "application/json",
"X-Api-Key": "YOUR_API_KEY"
},
body: JSON.stringify({
"name": "Enterprise Sales Agent v2"
})
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
"bytes"
"encoding/json"
)
func main() {
data := []byte(`{
"name": "Enterprise Sales Agent v2"
}`)
req, err := http.NewRequest("PATCH", "https://api.sendkit.ai/v1/agents/example_string", bytes.NewBuffer(data))
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Set("X-Api-Key", "YOUR_API_KEY")
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
fmt.Println("Response Status:", resp.Status)
}
require 'net/http'
require 'json'
uri = URI('https://api.sendkit.ai/v1/agents/example_string')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(uri)
request['Content-Type'] = 'application/json'
request['X-Api-Key'] = 'YOUR_API_KEY'
request.body = '{
"name": "Enterprise Sales Agent v2"
}'
response = http.request(request)
puts response.body
{
"success": true,
"data": {
"_id": "664a1b2c3d4e5f6a7b8c9d0e",
"name": "Enterprise Sales Agent v2",
"userId": "user_123",
"workspaceId": "ws_123",
"companyInfo": {
"name": "Acme Inc",
"description": "AI-powered email outreach platform with 10k+ customers"
},
"persona": {
"tone": "friendly",
"role": "sales representative",
"communicationStyle": "concise",
"customInstructions": "Always ask about their current tooling."
},
"isDefault": true,
"isActive": true,
"createdAt": "2024-06-01T10:00:00.000Z",
"updatedAt": "2024-06-05T14:30:00.000Z"
}
}
{
"error": "Not Found",
"message": "The requested resource was not found",
"code": 404
}
PATCH
/v1/agents/{agentId}PATCH
API Key (header: X-Api-Key)
X-Api-Keystring
RequiredPlatform API key (sk_user_...) or Workspace API key (sk_...)
Platform API key (sk_user_...) or Workspace API key (sk_...)
path
agentIdstring
RequiredAI agent ID
Content-Typestring
RequiredThe media type of the request body
Options: application/json
namestring
Agent name (trimmed)
companyInfoobject
Fields to merge into company info
personaobject
Fields to merge into persona
Request Preview
Response
Response will appear here after sending the request
Authentication
header
X-Api-Keystring
RequiredAPI Key for authentication. Platform API key (sk_user_...) or Workspace API key (sk_...)
Path Parameters
agentIdstring
RequiredAI agent ID
Body
application/json
namestring
Agent name (trimmed)
companyInfoobject
Fields to merge into company info
personaobject
Fields to merge into persona
Responses
successboolean
dataobject
_idstring
namestring
userIdstring
workspaceIdstring
companyInfoobject
personaobject
isDefaultboolean
isActiveboolean
createdAtstring
updatedAtstring
successboolean
errorobject
codestring
messagestring
Was this page helpful?
Last updated today
Built with Documentation.AI