> ## Documentation Index
> Fetch the complete documentation index at: https://developers.leadwaycrm.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Update Agent Metadata

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

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

```http theme={null}
PATCH https://services.leadconnectorhq.com/agent-studio/agent/{agentId}
```

## Autorización

<ParamField header="Authorization" type="string" required>
  Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
</ParamField>

<ParamField header="Version" type="string" required default="2021-07-28">
  Versión de la API.
</ParamField>

## Path parameters

<ParamField path="agentId" type="string" required default="p1q2r3s4t5u6v7w8x9y0z1a2" />

## Query parameters

<ParamField query="source" type="string" default="api" />

## Body

<ParamField body="locationId" type="string" required default="C2QujeCh8ZnC7al2InWR">
  Account ID for authorization (cannot be updated)
</ParamField>

<ParamField body="name" type="string" default="Updated Customer Support Agent">
  Name of the agent
</ParamField>

<ParamField body="description" type="string" default="Updated AI agent with enhanced customer support capabilities">
  Description of the agent
</ParamField>

<ParamField body="status" type="string" default="active">
  Status of the agent Posibles valores: 'active', 'inactive', 'archived'
</ParamField>

## Respuestas

<Accordion title="200 - Agent metadata updated successfully">
  <ResponseField name="success" type="boolean" required default="True">
    Success status
  </ResponseField>

  <ResponseField name="message" type="string" required default="Agent updated successfully">
    Response message
  </ResponseField>

  <ResponseField name="data" type="object" required>
    Updated agent or version data
  </ResponseField>

  ```json theme={null}
  {
    "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"
    }
  }
  ```
</Accordion>

<Accordion title="400 - Bad Request">
  ```json theme={null}
  {}
  ```
</Accordion>

<Accordion title="401 - Unauthorized">
  ```json theme={null}
  {}
  ```
</Accordion>

<Accordion title="404 - Agent not found" />

<Accordion title="422 - Unprocessable Entity">
  ```json theme={null}
  {}
  ```
</Accordion>

<Accordion title="500 - Internal Server Error">
  <ResponseField name="statusCode" type="number" default="500" />

  <ResponseField name="message" type="string" default="Internal Server Error" />

  ```json theme={null}
  {
    "statusCode": 500,
    "message": "Internal Server Error"
  }
  ```
</Accordion>

## Ejemplo

<CodeGroup>
  ```bash cURL theme={null}
  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"
  }'
  ```

  ```javascript Node.js theme={null}
  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();
  ```

  ```python Python theme={null}
  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 PHP theme={null}
  <?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);
  ```
</CodeGroup>