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

Create an organization case

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

Create an organization 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

companyIdstringObligatorioThe organization's id.

Cuerpo de la solicitud

application/json · obligatorio

projectIdstring (uuid) | nullOpcional
caseTypestringObligatorio1–120 characters
keystring | nullOpcional1–512 characters
titlestringObligatorio1–500 characters
summarystring | nullOpcionalat most 8000 characters
statusstringOpcionalone of: "draft", "in_progress", "in_review", "approved", "done", "cancelled"
fieldsobjectOpcional
parentCaseIdstring (uuid) | nullOpcional

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)