Skip to content
Olivares AI docs

Update an agent group; only fields present in the request are touched

PATCH
/v1/agent-groups/{id}
 
curl --request PATCH \
  --url https://example.com/v1/agent-groups/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "description": "example", "metadata": {}, "name": "example", "status": "active", "workspace_id": "example" }'

Partially updates one agent group: only fields present in the request are touched, so an omitted description or metadata is never wiped. The slug is immutable; a set workspace_id re-scopes the group and an explicit empty string clears the scope to tenant-wide.

Authorizations

Section titled “ Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “ Path Parameters ”
id
required
string format: uuid

Resource identifier (UUIDv7).

Header Parameters

Section titled “ Header Parameters ”
X-Olivares-Tenant
string format: uuid

Target tenant id; required when the principal can act in more than one tenant.

Request Body required

Section titled “ Request Body required ”
Media type application/json

Partial update: every field is a pointer, so an omitted field is left untouched (slug is immutable). A set workspace_id re-scopes the group; an explicit empty string clears the scope back to tenant-wide.

object
description
string
metadata
object
key
additional properties
any
name
string
status
string
Allowed values: active inactive
workspace_id
string

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

OK

Media type application/json
object
created_at
required
string format: date-time
description
string
id
required
string format: uuid
metadata
object
key
additional properties
any
name
required
string
slug
required

The stable scope handle ([a-z0-9][a-z0-9-]*, max 63).

string
status
required
string
Allowed values: active inactive
tenant_id
required
string format: uuid
updated_at
required
string format: date-time
version
required
integer format: int64
workspace_id

The group’s workspace scope; absent when tenant-wide.

string format: uuid
Example 
{
  "status": "active"
}

400

Section titled “ 400 ”

Bad request

Media type application/json
object
error
required
object
code
required
string
message
required
string
module

With code module_not_enabled: the namespace of the module this node does not run.

string
Example generated 
{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}

401

Section titled “ 401 ”

Unauthenticated

Media type application/json
object
error
required
object
code
required
string
message
required
string
module

With code module_not_enabled: the namespace of the module this node does not run.

string
Example generated 
{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}

403

Section titled “ 403 ”

Forbidden

Media type application/json
object
error
required
object
code
required
string
message
required
string
module

With code module_not_enabled: the namespace of the module this node does not run.

string
Example generated 
{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}

404

Section titled “ 404 ”

Not found

Media type application/json
object
error
required
object
code
required
string
message
required
string
module

With code module_not_enabled: the namespace of the module this node does not run.

string
Example generated 
{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}

409

Section titled “ 409 ”

Conflict / setup required

Media type application/json
object
error
required
object
code
required
string
message
required
string
module

With code module_not_enabled: the namespace of the module this node does not run.

string
Example generated 
{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}

429

Section titled “ 429 ”

Rate limited

Media type application/json
object
error
required
object
code
required
string
message
required
string
module

With code module_not_enabled: the namespace of the module this node does not run.

string
Example generated 
{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}