Skip to content

Support

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 Lessly 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

NameTypeRequiredDescription
idstringAgent id
titlestringNew job title, or null to clear it
isActivebooleanDeactivate or reactivate. A deactivated agent keeps every message it wrote and every thread it already sits on, but cannot be assigned to another one
avatarUrlstringNew avatar URL, or null to clear it
displayNamestringName the end user sees next to this agent replies
lesslyUserIdstringLessly identity to bind, or null to unbind. Stored verbatim, resolved by nobody

Response

FieldTypeAlwaysDescription
idstringAgent id
titlestringJob title shown under the name, or null if unset
isActivebooleanA deactivated agent keeps its history but can no longer be put on a thread
avatarUrlstringAvatar image URL, or null if unset
createdAtstringISO-8601 creation timestamp
updatedAtstringISO-8601 last-modification timestamp
displayNamestringName shown next to the agent replies
lesslyUserIdstringBound Lessly 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 Lessly 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.

navigateselect