La référence de l'API est publiée en anglais.

Update a case's facts, labels or status

PATCH/api/cases/{id}
Personal API keyAgent API keyConsole sessionExpérimental
Veyra Docs TeamMis à jour le Version 3 · Historique

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.

Autorisation

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. Fonctionnement des clés.

Paramètres de chemin

idstringObligatoireThe case's id.

Paramètres de requête

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

Corps de la requête

application/json · obligatoire

projectIdstring (uuid) | nullFacultatif
titlestringFacultatif1–500 characters
summarystring | nullFacultatifat most 8000 characters
statusstringFacultatifone of: "draft", "in_progress", "in_review", "approved", "done", "cancelled"
fieldsobjectFacultatif
parentCaseIdstring (uuid) | nullFacultatif
labelsarray<string (uuid)>Facultatif
labelIdsarray<string (uuid)>Facultatif

Réponses

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.

Les erreurs renvoient {"error": "..."}, souvent avec un code et des details. Voir erreurs et limites.

Cases (experimental)