---
title: "Update an agent group"
method: PATCH
path: "/api/v2/agentgroups/{group_id}"
tags: ["Agent Groups"]
---

# Update an agent group

`PATCH /api/v2/agentgroups/{group_id}`

## Request

- Base URL: `https://console.jumpcloud.com`
- URL: `https://console.jumpcloud.com/api/v2/agentgroups/{group_id}`
- Auth: API key in header `x-api-key`
- TypeScript: <https://skmtc.dev/jumpcloud/apis/jumpcloud-console-api/docs/api/v2/agentgroups/:group_id/patch.ts> (a function with typed inputs; its response is checked against the schema)

Updates an agent group. Omitted fields are left unchanged.

## Headers

- `x-org-id` string

## Request body

- AgentGroupData
  - `attributes` GraphAttributes, nullable: The graph attributes.
  - `description` string: Description of the agent group.
  - `name` string, required: Display name of the agent group.

## Response `200`

OK

- AgentGroup
  - `attributes` GraphAttributes, nullable: The graph attributes.
  - `description` string: Description of the agent group.
  - `id` string: Agent group ID (24-character hexadecimal string).
  - `name` string: Display name of the agent group. Can be used in the `filter` query parameter when listing agent groups.
  - `organizationObjectId` string, nullable: ID of the organization that owns the agent group (24-character hexadecimal string).
  - `type` 'agent_group': The type of the group; always `agent_group` for an agent group.

---

[API](https://skmtc.dev/jumpcloud/apis/jumpcloud-console-api.md) - [All operations](https://skmtc.dev/jumpcloud/apis/jumpcloud-console-api/llms.txt) - [OpenAPI document](https://skmtc.dev/jumpcloud/apis/jumpcloud-console-api/revisions/f396d9271b46?raw)