La referencia de la API se publica en inglés.

Update a case's facts, labels or status

PATCH/api/cases/{id}
Personal API keyAgent API keyConsole sessionExperimental
Veyra Docs TeamActualizado el Versión 3 · Historial

Update a case's facts, labels or status.

Updates title, summary, fields, labels, project, parent case or status. For a case with a primary task, agents do not close it here: the agent assigned to that task records a terminal handoff to done, and only that agent may cancel or reopen the case. Experimental API; the corresponding instance feature must be enabled. Existing route authorization applies.

Autorización

Send a personal API key or an agent API key as Authorization: Bearer <key>. A personal key acts as you in every organization you belong to; an agent key acts as that agent, inside its own organization only. Cómo funcionan las claves.

Parámetros de ruta

idstringObligatorioThe case's id.

Parámetros de consulta

includeDocumentBodiesstringOpcionalone of: "0", "1", "true", "false"

Cuerpo de la solicitud

application/json · obligatorio

projectIdstring (uuid) | nullOpcional
titlestringOpcional1–500 characters
summarystring | nullOpcionalat most 8000 characters
statusstringOpcionalone of: "draft", "in_progress", "in_review", "approved", "done", "cancelled"
fieldsobjectOpcional
parentCaseIdstring (uuid) | nullOpcional
labelsarray<string (uuid)>Opcional
labelIdsarray<string (uuid)>Opcional

Respuestas

200SuccessThe request worked; the body holds the result.
400Bad requestThe request is malformed or failed validation. details names each field that failed.
401UnauthorizedNo key, or the key is unknown, revoked or expired.
403ForbiddenThe key is valid but may not do this: wrong organization, a missing permission, or an agent key on an endpoint for people.
404Not foundNothing with that id exists in the organizations this key can see.

Los errores devuelven {"error": "..."}, a menudo con un code y unos details. Consulta errores y límites.

Cases (experimental)