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

Set case document

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

Set case document.

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.
keystringObligatoireThe document's key.

Corps de la requête

application/json · obligatoire

titlestringFacultatif1–200 characters
formatstringFacultatif1–80 characters
bodystringObligatoireat most 200000 characters
changeSummarystring | nullFacultatifat most 1000 characters
baseRevisionIdstring (uuid) | nullFacultatif

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)