Updates agent metadata such as name, description, and status.

http
PATCH https://services.leadconnectorhq.com/agent-studio/agent/{agentId}

Authorization

NameTypeRequiredExampleDescription
AuthorizationstringYesBearer token generated from the Leadway portal. See Authentication.
VersionstringYes2021-07-28API version.

Path parameters

NameTypeRequiredExampleDescription
agentIdstringYesp1q2r3s4t5u6v7w8x9y0z1a2

Query parameters

NameTypeRequiredExampleDescription
sourcestringNoapi

Body

NameTypeRequiredExampleDescription
locationIdstringYesC2QujeCh8ZnC7al2InWRAccount ID for authorization (cannot be updated)
namestringNoUpdated Customer Support AgentName of the agent
descriptionstringNoUpdated AI agent with enhanced customer support capabilitiesDescription of the agent
statusstringNoactiveStatus of the agent Possible values: 'active', 'inactive', 'archived'

Responses

200 - Agent metadata updated successfully
  • success (boolean, required): Success status Example: True

  • message (string, required): Response message Example: Agent updated successfully

  • data (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
{}
401 - Unauthorized
json
{}
404 - Agent not found
422 - Unprocessable Entity
json
{}
500 - Internal Server Error
  • statusCode (number): Example: 500

  • message (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"
}'

Last updated October 26, 2026

Was this page helpful?