Skip to main content
PATCH
Update an employee group

Authorizations

Authorization
string
header
required

Use an API key or OAuth access token. Enter only the token in the authorization dialog; requests send it as Authorization: Bearer <TOKEN>.

Create an API key in your workspace's Settings → API keys. Keys start with wm_api_ and only work in the workspace where they were created. Read-only keys can read data; creating, updating, or deleting data requires a read-write key.

OAuth access tokens are issued for connected Windmill applications.

Both token types use the authenticated user's workspace permissions. Each endpoint's permission requirements and the sharing settings of the requested items still apply.

Path Parameters

companyId
string
required

Company ID. A URL slug is also accepted. The caller must have access to this company.

Required string length: 1 - 128
Example:

"company-acme"

groupId
string
required

Opaque employee group identifier in this company.

Example:

"group-engineering"

Body

application/json

Updates name and categories together. Names are editable for MANUAL and FILTER groups; categories are editable for every group type. Omitted properties are unchanged.

name
string

Group name, trimmed, 1–200 characters. Duplicate group names are permitted.

Required string length: 1 - 200
Example:

"Engineering"

categoryIds
string<uuid>[]

Replacement list of up to 100 active category UUIDs. Duplicate IDs are deduplicated. Omit to keep existing categories; an empty list removes all categories.

Maximum array length: 100
Example:

Response

Update group details.

Confirmation that the command completed.

success
boolean
required

True when the command completed successfully.

Example:

true