Update a help desk team

Workforce module

PATCH/help-desk-teams/{id}helpDeskTeams.update

An internal team that answers help desk requests, with its first response target. 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.help.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

helpDeskTeams.update: Path and query parameters
Field	Type	Required	Description
id	string (uuid)	Yes	Identifier of the help desk team.

Request body: HelpDeskTeamUpdate

helpDeskTeams.update: HelpDeskTeamUpdate
Field	Type	Required	Description
name	string	No	Team name.Constraints: length 1 to 120
team_kind	"Operations" \| "IT" \| "HR" \| "Facilities" \| "Other"	No	Team kind.
description	string \| null	No	What the team helps with.Constraints: length 1 to 1000
first_response_hours	integer	No	Business hours to first response.Constraints: range 1 to any

{
  "name": "IT Desk",
  "team_kind": "Operations",
  "description": "Devices and accounts.",
  "first_response_hours": 8
}

Response 200: HelpDeskTeam

helpDeskTeams.update: HelpDeskTeam
Field	Type	Required	Description
id	string (uuid)	Yes	Identifier of the help desk team.
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	Team name.Constraints: length 1 to 120
team_kind	"Operations" \| "IT" \| "HR" \| "Facilities" \| "Other"	Yes	Team kind.
description	string \| null	Yes	What the team helps with.Constraints: length 1 to 1000
first_response_hours	integer	Yes	Business hours to first response.Constraints: range 1 to any
archived_at	string (date-time) \| null	Yes	When the team stopped taking requests.

{
  "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": "IT Desk",
  "team_kind": "Operations",
  "description": "Devices and accounts.",
  "first_response_hours": 8,
  "archived_at": "2026-10-08T14:30:00Z"
}

Code samples

curl -X PATCH "$XOS_BASE_URL/help-desk-teams/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":"IT Desk","team_kind":"Operations","description":"Devices and accounts.","first_response_hours":8}'

const { data, etag } = await xos.helpDeskTeams.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "name": "IT Desk",
    "team_kind": "Operations",
    "description": "Devices and accounts.",
    "first_response_hours": 8
  }, { ifMatch: etag });

response = xos.help_desk_teams.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"name": "IT Desk", "team_kind": "Operations", "description": "Devices and accounts.", "first_response_hours": 8}, if_match=etag)

xos help-desk-teams update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"name":"IT Desk","team_kind":"Operations","description":"Devices and accounts.","first_response_hours":8}' --if-match auto