Update a workforce group
Workforce module
PATCH/groups/{id}workforceGroups.update
A group space by department, project, crew or custom audience, with its own chat and files. Updates the fields sent; omitted fields are unchanged. Requires `If-Match` with the current `ETag`: a stale tag returns 412 and a missing tag returns 428.
- Requires the capability org.communication.write.
- OAuth scopes: org.
- Send If-Match with the ETag you read. A stale tag returns 412; a missing tag returns 428.
- Error statuses: 400, 401, 404, 412, 422, 428, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the workforce group. |
Request body: WorkforceGroupUpdate
| Field | Type | Required | Description |
|---|---|---|---|
| name | string | No | Group name, unique in the org.Constraints: length 1 to 120 |
| description | string | null | No | What the group is for.Constraints: length 1 to 2000 |
{
"name": "Rigging Crew",
"description": "Everyone flying points."
}Response 200: WorkforceGroup
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the workforce group. |
| org_id | string (uuid) | Yes | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Yes | When the row was created. |
| created_by | string (uuid) | null | Yes | Person who created the row; null for seed, platform or system writes. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| updated_by | string (uuid) | null | Yes | Person who last updated the row; null for seed, platform or system writes. |
| name | string | Yes | Group name, unique in the org.Constraints: length 1 to 120 |
| group_kind | "Department" | "Project" | "Crew" | "Custom" | Yes | What the group gathers. |
| project_id | string (uuid) | null | Yes | Identifier of the project a Project group gathers. |
| description | string | null | Yes | What the group is for.Constraints: length 1 to 2000 |
| archived_at | string (date-time) | null | Yes | When the group was archived. |
{
"id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"created_at": "2026-10-08T14:30:00Z",
"created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"updated_at": "2026-10-08T14:30:00Z",
"updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"name": "Rigging Crew",
"group_kind": "Department",
"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"description": "Everyone flying points.",
"archived_at": "2026-10-08T14:30:00Z"
}Code samples
curl -X PATCH "$XOS_BASE_URL/groups/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY" \
-H 'If-Match: W/"etag-from-your-last-read"' \
-H "Content-Type: application/json" \
-d '{"name":"Rigging Crew","description":"Everyone flying points."}'const { data, etag } = await xos.workforceGroups.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
"name": "Rigging Crew",
"description": "Everyone flying points."
}, { ifMatch: etag });response = xos.workforce_groups.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"name": "Rigging Crew", "description": "Everyone flying points."}, if_match=etag)xos workforce-groups update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"name":"Rigging Crew","description":"Everyone flying points."}' --if-match auto