solarOSsolarOS Docs

Create a Case

Creates a first-class service Case for an accessible Customer and linked Property. Requires Idempotency-Key. External References are created transactionally and conflicts return 409. Required scope: cases:write.

POST
/cases

Creates a first-class service Case for an accessible Customer and linked Property. Requires Idempotency-Key. External References are created transactionally and conflicts return 409. Required scope: cases:write.

Authorization

Authorization<token>

Organization API key. Format: Bearer sk_live_...

In: header

Request Body

application/json

JSON request payload for createCase.

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/cases" \  -H "Content-Type: application/json" \  -d '{    "customerId": "customer_123",    "propertyId": "property_123",    "subject": "Inverter is offline",    "description": "Monitoring data shows that the inverter stopped reporting this morning.",    "origin": "MONITORING_ALERT",    "severity": "MEDIUM",    "category": "MONITORING"  }'
{  "data": {    "id": "string",    "caseNumber": "string",    "customerId": "string",    "propertyId": "string",    "systemId": "string",    "projectId": "string",    "sourceServiceRequestId": "string",    "subject": "string",    "description": "string",    "origin": "string",    "severity": "string",    "category": "string",    "status": "string",    "resolution": "string",    "ownerId": "string",    "openedAt": "2019-08-24T14:15:22Z",    "firstResponseAt": "2019-08-24T14:15:22Z",    "resolvedAt": "2019-08-24T14:15:22Z",    "closedAt": "2019-08-24T14:15:22Z",    "slaResponseDueAt": "2019-08-24T14:15:22Z",    "slaResolutionDueAt": "2019-08-24T14:15:22Z",    "externalReferences": [      {}    ],    "customFields": {},    "submissionAnswers": {},    "reportedHardware": [      {}    ],    "submittedContact": {},    "externalRecordLinks": [      {        "id": "string",        "externalSystem": "string",        "externalSystemLabel": "string",        "objectLabel": "string",        "recordLabel": "string",        "url": "http://example.com",        "externalId": "string",        "data": {},        "createdAt": "2019-08-24T14:15:22Z"      }    ]  },  "meta": {    "requestId": "string",    "version": "v1",    "timestamp": "2019-08-24T14:15:22Z",    "rateLimit": {      "limit": 0,      "remaining": 0,      "reset": 0    }  }}