Skip to content

support_agent_update

Edit an agent profile.

Tool

support_agent_update

Edit an agent profile.

Edit an agent profile. Pass null to clear the title, the avatar or the Lepsto binding; omit a field to leave it alone. Setting isActive to false deactivates the agent: it keeps every message it wrote and every thread it already sits on, but cannot be assigned to another one

Behavior

HTTP
PATCH /support/agents/:id

Arguments

Name
Type
Required
Description
id
string
•
Agent id
title
string
—
New job title, or null to clear it
isActive
boolean
—
Deactivate or reactivate. A deactivated agent keeps every message it wrote and every thread it already sits on, but cannot be assigned to another one
avatarUrl
string
—
New avatar URL, or null to clear it
displayName
string
—
Name the end user sees next to this agent replies
lesslyUserId
string
—
Lepsto identity to bind, or null to unbind. Stored verbatim, resolved by nobody

Response

Field
Type
Always
Description
id
string
•
Agent id
title
string
•
Job title shown under the name, or null if unset
isActive
boolean
•
A deactivated agent keeps its history but can no longer be put on a thread
avatarUrl
string
•
Avatar image URL, or null if unset
createdAt
string
•
ISO-8601 creation timestamp
updatedAt
string
•
ISO-8601 last-modification timestamp
displayName
string
•
Name shown next to the agent replies
lesslyUserId
string
•
Bound Lepsto identity, stored verbatim and resolved by nobody. Null for an unbound profile — a bot or the client's own backend, which replies just like anyone else

Try it

Edit an agent profile.

When to use

Edit an agent profile. Pass null to clear the title, the avatar or the Lepsto binding; omit a field to leave it alone. Setting isActive to false deactivates the agent: it keeps every message it wrote and every thread it already sits on, but cannot be assigned to another one

Example

Ask your agent something like this:

Edit an agent profile.

The agent will invoke support_agent_update with these arguments:

{
  "id": "<id>"
}

Esc

Start typing to search the docs.

↑↓navigate↵select