Saltar al contenido

Create a help desk team

Módulo Workforce

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.

  • Requiere la capacidad org.help.write.
  • Alcances de OAuth: org.
  • Envía el encabezado Idempotency-Key. Una repetición con la misma clave devuelve la respuesta original.
  • Estados de error: 400, 401, 409, 422, 429. Los errores son detalles de problema RFC 9457.

Cuerpo de la solicitud: HelpDeskTeamCreate

helpDeskTeams.create: HelpDeskTeamCreate
CampoTipoObligatorioDescripción
namestringSíTeam name.Restricciones: length 1 to 120
team_kind"Operations" | "IT" | "HR" | "Facilities" | "Other"SíTeam kind.
descriptionstring | nullNoWhat the team helps with.Restricciones: length 1 to 1000
first_response_hoursintegerSíBusiness hours to first response.Restricciones: range 1 to any
{
  "name": "IT Desk",
  "team_kind": "Operations",
  "description": "Devices and accounts.",
  "first_response_hours": 8
}

Respuesta 201: HelpDeskTeam

helpDeskTeams.create: HelpDeskTeam
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the help desk team.
org_idstring (uuid)SíIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)SíWhen the row was created.
created_bystring (uuid) | nullSíPerson who created the row; null for seed, platform or system writes.
updated_atstring (date-time)SíWhen the row was last updated.
updated_bystring (uuid) | nullSíPerson who last updated the row; null for seed, platform or system writes.
namestringSíTeam name.Restricciones: length 1 to 120
team_kind"Operations" | "IT" | "HR" | "Facilities" | "Other"SíTeam kind.
descriptionstring | nullSíWhat the team helps with.Restricciones: length 1 to 1000
first_response_hoursintegerSíBusiness hours to first response.Restricciones: range 1 to any
archived_atstring (date-time) | nullSí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"
}

Ejemplos de código

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}'