Skip to main content
POST
Update Agent Group
Use this API to update an agent group’s name and/or description.
This endpoint updates only name and description. It cannot change membership; use Add Agents / Remove Agents for that. metadata is immutable after creation. Sending metadata, agentIds, or any other unknown field is rejected with a validation error (.strict()).
At least one of name or description must be provided; an empty update is rejected.
System groups (copy-qa, seo, design-checks, performance, brand-checks) are not protected from renaming. Passing one of their ids renames it like any other group, and the new name persists for every user in the workspace. There is no way to restore the original name except by setting it again yourself.

Endpoint

POST https://api.velt.dev/v2/agents/groups/update

Headers

string
required
Your API key.
string
required

Body

Params

object
required

Example Requests

Response

Success Response

Returns the updated group document, the same shape as Get Group. System groups carry system: true; groups you created omit the field.

Failure Response

Errors:
  • NOT_FOUND: the group does not exist.
  • INVALID_ARGUMENT: neither name nor description provided, over-length values, or unknown fields (e.g. metadata, agentIds) sent.