API ReferenceCases
Update a case
Update a case's title, description, or status.
Requires cases:write scope.
Coming soon. This endpoint is not yet available.
Authorization
bearerAuth cases:writeAuthorizationBearer <token>
API token from your dashboard.
Format: so_live_... (production) or so_test_... (test mode).
Tokens carry one or more scopes. Request only the scopes your integration needs:
| Scope | Grants |
|---|---|
media:read | List and retrieve files |
media:write | Upload and delete files |
logs:read | Read log entries |
logs:write | Ingest log entries |
cases:read | Read cases |
cases:write | Create and update cases |
apps:read | Read apps |
apps:write | Submit apps |
usage:read | Read quota usage |
members:read | List organisation members |
members:write | Invite and remove members |
billing:read | Read billing and subscription info |
tokens:write | Create and revoke API tokens |
In: header
Scope: cases:write
Path Parameters
id*string
Case ID
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X PATCH "https://example.com/cases/string" \ -H "Content-Type: application/json" \ -d '{}'{
"id": "string",
"title": "string",
"description": "string",
"status": "open",
"attachments": [
{
"id": "f_01HZXXXXXXXXXXXXXXXXXXXXX",
"url": "https://media.serverops.gg/p_01HZ.../screenshot.png",
"key": "string",
"size": 2097152,
"content_type": "image/png",
"sha256": "string",
"original_name": "screenshot.png",
"tags": [
"string"
],
"folder": "string",
"abuse_status": "clean",
"visibility": "public",
"storage_class": "standard",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}{
"error": {
"code": "bad_request",
"message": "missing required field"
}
}{
"error": {
"code": "unauthorized",
"message": "missing or invalid authorization token"
}
}{
"error": {
"code": "forbidden",
"message": "token does not have the required scope"
}
}{
"error": {
"code": "not_found",
"message": "file not found"
}
}{
"error": {
"code": "internal",
"message": "an unexpected error occurred"
}
}