Update Case
Update supported fields on an existing Monolith Case using its UUID.
The Update Case endpoint updates supported fields on an existing Case identified by its UUID.
Only fields included in the request body are updated.
Endpoint
PUT /api/v1/cases/:uuidAll requests require a valid API key in the X-API-KEY request header.
Because this endpoint accepts JSON data, include the following content type:
Content-Type: application/jsonSee Authentication for additional API authentication guidance.
Path Parameters
uuid
string
Yes
UUID of the Case to update.
Body Parameters
Only the supported fields below are accepted. Unknown fields return an HTTP 400 response.
case_name
string
No
Maximum length 255. Cannot contain +, <, >, :, ", /, or \.
case_number
string
No
Maximum length 255. Uses the same character restrictions as case_name.
description
string
No
Maximum length 2000.
status
string
No
Maximum length 255.
type
string
No
Maximum length 255.
case_lead_id
integer
No
Must be a positive integer.
client_id
integer
No
Must be a positive integer.
case_open_date
string
No
Must use the YYYY-MM-DD format and contain a valid calendar date.
case_closed_date
string
No
Must use the YYYY-MM-DD format and contain a valid calendar date.
Successful Response
A successfully updated Case returns an HTTP 200 response.
Error Responses
400 - Validation Error
A request containing unsupported or invalid data returns an HTTP 400 response.
400 - Case Not Found
If the supplied UUID does not resolve to an existing Case, the API returns an HTTP 400 response.
500 - Server Error
An unexpected server error may return an HTTP 500 response.
Example Request
The following example updates several fields on an existing Case.
Replace <api-base-url> with the /api/v1 base URL for your Monolith environment and <case-uuid> with the UUID of the Case you want to update.
See API Endpoints for the correct API base URL.
Related Documentation
Last updated
Was this helpful?