Create a help desk team

Workforce module

POST/help-desk-teamshelpDeskTeams.create

An internal team that answers help desk requests, with its first response target. Creates a help desk team. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

Requires the capability org.help.write.
OAuth scopes: org.
Send an Idempotency-Key header. A replay with the same key returns the original response.
Error statuses: 400, 401, 409, 422, 429. Errors are RFC 9457 problem details.

Request body: HelpDeskTeamCreate

helpDeskTeams.create: HelpDeskTeamCreate
Field	Type	Required	Description
name	string	Yes	Team name.Constraints: length 1 to 120
team_kind	"Operations" \| "IT" \| "HR" \| "Facilities" \| "Other"	Yes	Team kind.
description	string \| null	No	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

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

Response 201: HelpDeskTeam

helpDeskTeams.create: 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 POST "$XOS_BASE_URL/help-desk-teams" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"name":"IT Desk","team_kind":"Operations","description":"Devices and accounts.","first_response_hours":8}'

const { data } = await xos.helpDeskTeams.create({
    "name": "IT Desk",
    "team_kind": "Operations",
    "description": "Devices and accounts.",
    "first_response_hours": 8
  });

response = xos.help_desk_teams.create({"name": "IT Desk", "team_kind": "Operations", "description": "Devices and accounts.", "first_response_hours": 8})

xos help-desk-teams create --data '{"name":"IT Desk","team_kind":"Operations","description":"Devices and accounts.","first_response_hours":8}'