Skip to main content
PUT
/
v1
/
agent
/
{agentId}
JavaScript
import Roark from '@roarkanalytics/sdk';

const client = new Roark({
  bearerToken: process.env['ROARK_API_BEARER_TOKEN'], // This is the default and can be omitted
});

const agent = await client.agent.update('agentId');

console.log(agent.data);
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "description": "<string>",
    "customId": "<string>",
    "createdAt": "<string>",
    "updatedAt": "<string>"
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

agentId
string
required

The ID of the agent to update

Body

application/json

Input for updating an existing agent

name
string

Name of the agent

Minimum string length: 1
description
string | null

Description of the agent

Response

The updated agent

data
object
required