Skip to main content
PUT
Replace employee group sharing

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

Replace editable sharing grants. System-managed permissions are preserved.

companyAccess
enum<string>
required

Access for everyone in this company.

Available options:
none,
read,
write
Example:

"read"

allManagersAccess
enum<string>
required

Access for employees who manage others.

Available options:
none,
read,
write
Example:

"read"

employeeAccess
Employee access · object[]
required

Replacement employee grants. Omitted employees lose their direct grant.

Maximum array length: 500
Example:
groupAccess
Group access · object[]
required

Replacement employee-group grants.

Maximum array length: 500
Example:
subtreeAccess
Reporting subtree access · object[]
required

Replacement reporting-subtree grants.

Maximum array length: 500
Example:

Response

Set group sharing.

Confirmation that the command completed.

success
boolean
required

True when the command completed successfully.

Example:

true