Updates agent metadata such as name, description, and status.
http
PATCH https://services.leadconnectorhq.com/agent-studio/agent/{agentId}Authorization
| Name | Type | Required | Example | Description |
|---|---|---|---|---|
Authorization | string | Yes | Bearer token generated from the Leadway portal. See Authentication. | |
Version | string | Yes | 2021-07-28 | API version. |
Path parameters
| Name | Type | Required | Example | Description |
|---|---|---|---|---|
agentId | string | Yes | p1q2r3s4t5u6v7w8x9y0z1a2 |
Query parameters
| Name | Type | Required | Example | Description |
|---|---|---|---|---|
source | string | No | api |
Body
| Name | Type | Required | Example | Description |
|---|---|---|---|---|
locationId | string | Yes | C2QujeCh8ZnC7al2InWR | Account ID for authorization (cannot be updated) |
name | string | No | Updated Customer Support Agent | Name of the agent |
description | string | No | Updated AI agent with enhanced customer support capabilities | Description of the agent |
status | string | No | active | Status of the agent Possible values: 'active', 'inactive', 'archived' |
Responses
200 - Agent metadata updated successfully
success(boolean, required): Success status Example:Truemessage(string, required): Response message Example:Agent updated successfullydata(object, required): Updated agent or version data
json
{
"success": true,
"message": "Agent updated successfully",
"data": {
"agentId": "p1q2r3s4t5u6v7w8x9y0z1a2",
"versionId": "v1a2b3c4d5e6f7g8h9i0",
"name": "Updated Customer Support Agent",
"description": "Updated AI agent with enhanced customer support capabilities",
"status": "active",
"updatedAt": "2024-02-27T11:45:00.000Z"
}
}400 - Bad Request
json
{}404 - Agent not found
422 - Unprocessable Entity
json
{}500 - Internal Server Error
statusCode(number): Example:500message(string): Example:Internal Server Error
json
{
"statusCode": 500,
"message": "Internal Server Error"
}Example
curl -X PATCH 'https://services.leadconnectorhq.com/agent-studio/agent/YOUR_agentId' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28' \
-H 'Content-Type: application/json' \
-d '{
"locationId": "C2QujeCh8ZnC7al2InWR",
"name": "Updated Customer Support Agent",
"description": "Updated AI agent with enhanced customer support capabilities",
"status": "active"
}'const response = await fetch('https://services.leadconnectorhq.com/agent-studio/agent/YOUR_agentId', {
method: 'PATCH',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
'Content-Type': 'application/json',
},
body: JSON.stringify({"locationId": "C2QujeCh8ZnC7al2InWR", "name": "Updated Customer Support Agent", "description": "Updated AI agent with enhanced customer support capabilities", "status": "active"}),
});
const data = await response.json();import os, requests
response = requests.request(
'PATCH',
'https://services.leadconnectorhq.com/agent-studio/agent/YOUR_agentId',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
'Content-Type': 'application/json',
},
json={"locationId": "C2QujeCh8ZnC7al2InWR", "name": "Updated Customer Support Agent", "description": "Updated AI agent with enhanced customer support capabilities", "status": "active"},
)
data = response.json()<?php
$ch = curl_init('https://services.leadconnectorhq.com/agent-studio/agent/YOUR_agentId');
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => 'PATCH',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode({'locationId': 'C2QujeCh8ZnC7al2InWR', 'name': 'Updated Customer Support Agent', 'description': 'Updated AI agent with enhanced customer support capabilities', 'status': 'active'}),
]);
$data = json_decode(curl_exec($ch), true);