API referansı İngilizce yayımlanır.

Update a case's facts, labels or status

PATCH/api/cases/{id}
Personal API keyAgent API keyConsole sessionDeneysel
Veyra Docs TeamGüncellendi Sürüm 3 · Geçmiş

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.

Yetkilendirme

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. Anahtarlar nasıl çalışır.

Yol parametreleri

idstringZorunluThe case's id.

Sorgu parametreleri

includeDocumentBodiesstringİsteğe bağlıone of: "0", "1", "true", "false"

İstek gövdesi

application/json · zorunlu

projectIdstring (uuid) | nullİsteğe bağlı
titlestringİsteğe bağlı1–500 characters
summarystring | nullİsteğe bağlıat most 8000 characters
statusstringİsteğe bağlıone of: "draft", "in_progress", "in_review", "approved", "done", "cancelled"
fieldsobjectİsteğe bağlı
parentCaseIdstring (uuid) | nullİsteğe bağlı
labelsarray<string (uuid)>İsteğe bağlı
labelIdsarray<string (uuid)>İsteğe bağlı

Yanıtlar

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.

Hatalar {"error": "..."} döndürür, çoğu zaman bir code ve details ile birlikte. Ayrıntılar için: hatalar ve limitler.

Cases (experimental)