Archive a group
Workforce module
POST/groups/{id}/archiveworkforceGroups.archive
Archives the group; it keeps its history and takes no new messages. Archiving is final. Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.
- Requires the capability org.communication.write.
- OAuth scopes: org.
- Send an Idempotency-Key header. A replay with the same key returns the original response.
- Error statuses: 400, 401, 404, 409, 422, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the workforce group. |
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 POST "$XOS_BASE_URL/groups/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f/archive" \
-H "Authorization: Bearer $XOS_API_KEY" \
-H "Idempotency-Key: $(uuidgen)"const { data } = await xos.workforceGroups.archive("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.workforce_groups.archive("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos workforce-groups archive 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f