Create a help desk request

Módulo Workforce

POST/help-desk-requestshelpDeskRequests.create

A help desk request: an Organization queue support ticket routed to an internal team, with assignment and response deadline. Creates a help desk request. 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 inbox.notifications.write.
Alcances de OAuth: inbox.
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: HelpDeskRequestCreate

helpDeskRequests.create: HelpDeskRequestCreate
Campo	Tipo	Obligatorio	Descripción
help_desk_team_id	string (uuid)	Sí	Identifier of the team the request is routed to.
category	"Question" \| "Problem" \| "Access" \| "Billing" \| "Account" \| "Feature Request"	Sí	What it is about.
severity	"Severity 3" \| "Severity 1" \| "Severity 2" \| "Severity 4"	Sí	Severity.
subject	string	Sí	One-line summary.Restricciones: length 1 to 200
body	string	Sí	What happened and what is needed.Restricciones: length 1 to 20000

{
  "help_desk_team_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "category": "Question",
  "severity": "Severity 3",
  "subject": "Tablet will not sign in",
  "body": "The dock tablet shows a blank screen."
}

Respuesta 201: HelpDeskRequest

helpDeskRequests.create: HelpDeskRequest
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the help desk request.
org_id	string (uuid)	Sí	Identifier of the owning organization, derived from the parent row and never accepted from the caller.
created_at	string (date-time)	Sí	When the row was created.
created_by	string (uuid) \| null	Sí	Person who created the row; null for seed, platform or system writes.
updated_at	string (date-time)	Sí	When the row was last updated.
updated_by	string (uuid) \| null	Sí	Person who last updated the row; null for seed, platform or system writes.
ticket_number	string	Sí	Display number.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
help_desk_team_id	string (uuid)	Sí	Identifier of the team the request is routed to.
category	"Question" \| "Problem" \| "Access" \| "Billing" \| "Account" \| "Feature Request"	Sí	What it is about.
severity	"Severity 3" \| "Severity 1" \| "Severity 2" \| "Severity 4"	Sí	Severity.
subject	string	Sí	One-line summary.Restricciones: length 1 to 200
body	string	Sí	What happened and what is needed.Restricciones: length 1 to 20000
ticket_state	"Open" \| "Waiting" \| "Resolved" \| "Closed"	Sí	Request state.
membership_id	string (uuid)	Sí	Identifier of the member who asked.
assignee_membership_id	string (uuid) \| null	Sí	Identifier of the team member it is assigned to.
help_desk_response_due_at	string (date-time) \| null	Sí	When the first response is due.
first_responded_at	string (date-time) \| null	Sí	When the team first answered.

{
  "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",
  "ticket_number": "SUP-0001",
  "help_desk_team_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "category": "Question",
  "severity": "Severity 3",
  "subject": "Tablet will not sign in",
  "body": "The dock tablet shows a blank screen.",
  "ticket_state": "Open",
  "membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "assignee_membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "help_desk_response_due_at": "2026-10-08T14:30:00Z",
  "first_responded_at": "2026-10-08T14:30:00Z"
}

Ejemplos de código

curl -X POST "$XOS_BASE_URL/help-desk-requests" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"help_desk_team_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","category":"Question","severity":"Severity 3","subject":"Tablet will not sign in","body":"The dock tablet shows a blank screen."}'

const { data } = await xos.helpDeskRequests.create({
    "help_desk_team_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "category": "Question",
    "severity": "Severity 3",
    "subject": "Tablet will not sign in",
    "body": "The dock tablet shows a blank screen."
  });

response = xos.help_desk_requests.create({"help_desk_team_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "category": "Question", "severity": "Severity 3", "subject": "Tablet will not sign in", "body": "The dock tablet shows a blank screen."})

xos help-desk-requests create --data '{"help_desk_team_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","category":"Question","severity":"Severity 3","subject":"Tablet will not sign in","body":"The dock tablet shows a blank screen."}'