Hanzo
OpenapiHelp

Files a customer support ticket into the public help center.

Files a customer support ticket into the public help center.

POST /v1/help/tickets

Addresshttps://api.hanzo.ai/v1/help/tickets
MethodPOST
Operationpost_help_tickets
AuthAuthorization: Bearer $HANZO_API_KEY

Files a customer support ticket into the public help center. It creates the ticket (status Open, source portal) with the customer's message on the description, then records that same message as the opening entry of the ticket's conversation thread; the description carries it regardless, so failing to write that entry loses nothing. Answers 201 with an opaque reference.

A deployment with no help center answers 404, one whose center has not installed the Help model answers 503, and a body over 64 KiB answers 413 — in that order, which is the order the route has always decided them in.

Request

4 fields, body application/json (required).

FieldInTypeRequiredDescription
descriptionbodystringDescription is the customer's message.
emailbodystringEmail is how the support team replies. Required; clipped at 320 characters (the RFC 5321 maximum).
prioritybodystringPriority is Low, Medium, High or Urgent, case-insensitively.
subjectbodystringSubject is the one-line summary of the problem.

Response

StatusBodyMeaning
201helpTicketFiledcreated

201 body — 2 fields.

FieldInTypeAlwaysDescription
statusbodystringStatus is the lifecycle state the ticket was filed in — always "Open".
ticketbodystringTicket is the opaque, random customer-facing reference ("tkt_" + 24 hex characters).

Failure carries the platform error shape — see Errors.

Examples

hanzo has no subcommand for this operation — the CLI serves only what cloud's live route table confirms. Use HTTP or an SDK.


Help API · All Hanzo APIs · Interactive reference

How is this guide?

On this page