latestOpenAPI 3.0.02026-08-10221235717.8 KB

e21ad140ec3c

Agents

public

Update the description of an Agent.

patch/orgs/{orgId}/agents/{agentId}

Path parameters

orgIdstring required

The Organization ID

agentIdstring required

The Agent id.

Request body

descriptionstring required

A description to show future users. It can be empty.

Example request

{
  "description": "One of my agents."
}

Response

Agent updated.

idstring required

The Agent id.

descriptionstring

A description to show future users. It can be empty.

created_atstring date-time required

Time of the Agent being registered.

created_bystring required

User ID of user that added the Agent.

Example response

{
  "id": "agent-id",
  "description": "One of my agents.",
  "created_at": "2020-06-22T09:37:23.523Z",
  "created_by": "00000000-0000-0000-0000-000000000000"
}