---
title: "PATCH /work-management/{tenantLocator}/workgroups/{workgroupLocator}"
method: PATCH
path: "/work-management/{tenantLocator}/workgroups/{workgroupLocator}"
---

# PATCH /work-management/{tenantLocator}/workgroups/{workgroupLocator}

`PATCH /work-management/{tenantLocator}/workgroups/{workgroupLocator}`

## Request

- Base URL: `https://docs.socotra.com`
- URL: `https://docs.socotra.com/work-management/{tenantLocator}/workgroups/{workgroupLocator}`
- Auth: none declared
- TypeScript: <https://skmtc.dev/socotra/apis/socotra-insurance-suite-openapi/docs/work-management/:tenantLocator/workgroups/:workgroupLocator/patch.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `tenantLocator` string, uuid, required
- `workgroupLocator` string, ulid, required

## Request body

- WorkgroupPatchRequest
  - `name` string
  - `setSubgroups` string[], required
  - `removeSubgroups` string[], required
  - `setUsers` string[], required
  - `removeUsers` string[], required
  - `parentLocator` string, ulid
  - `region` string
  - `tag` string
  - `empty` boolean, required

## Response `200`

OK

- WorkgroupResponse
  - `locator` string, ulid, required
  - `name` string, required
  - `workgroupState` 'active' | 'discarded', required
  - `subgroups` WorkgroupResponse[], required
  - `users` string[], required
  - `entities` string[], required
  - `tasks` string[], required
  - `parent` string, ulid
  - `region` string
  - `tag` string
  - `createdBy` string, uuid, required
  - `createdAt` string, date-time, required

---

[API](https://skmtc.dev/socotra/apis/socotra-insurance-suite-openapi.md) - [All operations](https://skmtc.dev/socotra/apis/socotra-insurance-suite-openapi/llms.txt) - [OpenAPI document](https://skmtc.dev/socotra/apis/socotra-insurance-suite-openapi/revisions/77ee7d8172b9?raw)