Skip to main content
PATCH
/
api
/
cases
/
{id}
Update Case
curl --request PATCH \
  --url https://app.sphinxhq.com/api/cases/{id}/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "webhook_url": "<string>",
  "delete_after": -1,
  "metadata": {},
  "sync_platforms": {},
  "external_id": "<string>"
}
'
{
  "webhook_url": "https://example.com/webhook/updated"
}

Authorizations

​
Authorization
string
header
required

OAuth2 access token obtained from POST /api/oauth/token/ using client credentials.

Path Parameters

​
id
integer
required

A unique integer value identifying this generic case.

Body

Write serializer for updating an existing GenericCase (PATCH).

​
webhook_url
string | null

Webhook sent on case completion.

Maximum string length: 511
​
delete_after
integer

Days until deletion. -1 means never delete.

Required range: -2147483648 <= x <= 2147483647
​
metadata
object

Case-specific details for display in UI. Flexible JSON object.

​
sync_platforms
object

External platform references for outbound sync. List of dicts, e.g. [{"domain": "bofi--dev.sandbox.my.salesforce.com", "id": "500WA..."}]

​
external_id
string | null

External ID for the case. Must be unique per org among non-archived cases.

Maximum string length: 512

Response

200 - application/json

Read-only serializer for GenericCase with related objects.

​
id
integer
required
read-only
​
external_id
string
required
read-only

External ID for the case. Auto-generated UUID if not provided. Stable across reruns.

​
origin_url
string | null
required
read-only

Deprecated alias for external_id.

​
customer
object
required

Nested customer serializer for GenericCase responses.

​
note
string | null
required
read-only
​
risk_score
number<double> | null
required
read-only

Risk score (max of check risk scores for the case).

​
outcome
enum<string> | null
required
read-only
  • ACCEPTED - Accepted
  • REJECTED - Rejected
  • PENDING - Pending
Available options:
ACCEPTED,
REJECTED,
PENDING,
null
​
is_complete
boolean
required
read-only
​
failed
boolean
required
read-only
​
created_at
string<date-time>
required
read-only
​
updated_at
string<date-time>
required
read-only
​
checks
object[]
required
read-only
​
rfi
object
required
read-only
​
webhook_url
string | null

Webhook sent on case completion.

Maximum string length: 511
​
delete_after
integer

Days until deletion. -1 means never delete.

Required range: -2147483648 <= x <= 2147483647
​
metadata
object

Case-specific metadata in JSON format.

​
sync_platforms
object

External platform references for outbound sync. List of dicts, e.g. [{"domain": "bofi--dev.sandbox.my.salesforce.com", "id": "500WA..."}]