Create and track cases through the API
The requests to create a case, add replies, check its status, download attachments and answer the survey from your system.
On this page
With a channel's URL to create cases, your server creates and tracks cases in the desk. All requests are signed: read Sign requests.
On this page, {URL} is the channel URL, for example https://api-itsm.argunis.com/api/public/cases/v1/AbC….
Create a case
POST {URL}/cases with this JSON body:
{
"externalId": "7c1e0b9a-4f1d-4a51-9a3e-2d5b8f0c1a22",
"subject": "No puedo exportar el reporte mensual",
"description": "Al presionar Exportar aparece un error.",
"kind": "incident",
"urgency": 2,
"impact": 2,
"category": "Reportes",
"requester": { "email": "ana@cliente.cl", "name": "Ana Pérez", "phone": "+56 9 1234 5678" },
"company": { "name": "Cliente SpA", "taxId": "76.123.456-7" },
"context": { "pantalla": "/reportes/mensual", "version": "4.2.1", "navegador": "Chrome 141" },
"attachments": [{ "filename": "error.png", "contentType": "image/png", "dataBase64": "iVBORw0KGgo…" }]
}Field | Required | Use |
|---|---|---|
| yes | The case identifier in your system (up to 100 characters: letters, numbers and |
| yes | Subject, from 3 to 200 characters. |
| no | Details, up to 20,000 characters. |
| no |
|
| no | 1 high, 2 medium, 3 low. If missing, the channel's. |
| no | Name of a category in the desk. If it does not match, the channel's. |
| yes | Email and name of the person asking for help. The phone is optional. |
| no | The requester's company: name and RUT. |
| no | Up to 20 text values that help the team (screen, version, browser). They are added at the end of the description. |
| no | Up to 5 files of 5 MB each, in base64. The same types as in tickets are accepted. |
Responses:
Code | Meaning |
|---|---|
201 | Case created. It returns |
200 | A case with that |
400 | A field is not valid; |
403 | The requester is not allowed by the channel. |
Generate the externalId before sending and store it. If the network fails, retry with the same externalId and a new webhook-id: the case is never duplicated.
The case Elion ITSM returns
{
"case": {
"number": "INC-000123",
"externalId": "7c1e0b9a-4f1d-4a51-9a3e-2d5b8f0c1a22",
"subject": "No puedo exportar el reporte mensual",
"state": "in_progress",
"stateLabel": "En revisión",
"waitingOn": "team",
"priority": "P3",
"createdAt": "2026-10-13T14:02:11.000Z",
"updatedAt": "2026-10-13T14:20:45.000Z",
"resolvedAt": null,
"closedAt": null,
"resolution": null,
"assignee": { "name": "Carla Soto" },
"csatPending": false,
"publicMessages": [
{ "id": "981", "side": "agent", "author": "Carla Soto", "body": "Hola Ana, ¿qué formato elegiste?", "at": "2026-10-13T14:20:45.000Z", "attachments": [] }
]
}
}stateLabelis already written for the requester, in Spanish:Recibida(received),En revisión(in review),Esperando tu respuesta(waiting for your reply),Resuelta(resolved),Cerrada(closed),Cancelada(cancelled).waitingOnsays who has to act:team(the team),requester(the requester) ornullif it is finished.publicMessagescontains only the conversation with the requester, the last 200 messages. Never the team's internal notes.bodyis plain text: show it as text, not as HTML.
Check a case
GET {URL}/cases/{ref}, where {ref} is the number (INC-000123) or your externalId. It returns { "case": … }. It only finds cases created by that channel.
Reply
POST {URL}/cases/{ref}/replies:
{ "body": "Elegí PDF.", "author": { "email": "ana@cliente.cl", "name": "Ana Pérez" }, "attachments": [] }It counts as a reply from the requester: if the team had it On hold waiting for their reply, the case goes back to In progress, and if it was Resolved, it is reopened. A Closed case returns 409: you need to create a new one.
Download an attachment
GET {URL}/cases/{ref}/attachments/{id}, with the id that comes in publicMessages. It only returns attachments from the case's public conversation.
Answer the survey
When csatPending is true, POST {URL}/cases/{ref}/csat:
{ "score": 5, "comment": "Rápido y claro." }score goes from 1 to 5. If there is no pending survey, it returns 409.