Create Case
Create a new Monolith Case using supported Case fields and relationships.
The Create Case endpoint creates a new Case in Monolith using the supported fields provided in the request body.
Endpoint
POST /api/v1/casesAll 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.
Body Parameters
Only the supported fields below are accepted. Unknown fields return an HTTP 400 response.
case_name
string
Yes
Maximum length 255. Cannot contain +, <, >, :, ", /, or \.
case_number
string
No
Maximum length 255. Uses the same character restrictions as case_name. Must be unique if provided.
description
string
No
Maximum length 2000.
case_status
string
No
Maximum length 255.
case_type
string
No
Maximum length 255.
case_lead_id
integer
No
Monolith user ID to assign as the Case Lead.
case_open_date
date
No
Must contain a valid date value.
user_group_uuid
string or string[]
No
Accepts either one user group UUID or an array of user group UUIDs.
client_id
integer
No
Monolith Client ID to associate with the Case.
Successful Response
A successfully created Case returns an HTTP 200 response.
The response includes identifiers for the newly created Case that can be used with other Monolith API endpoints.
Error Responses
400 - Validation Error
A request containing invalid or missing required data returns an HTTP 400 response.
400 - Duplicate Case Number
If case_number is provided, it must be unique.
500 - Server Error
An unexpected server error may return an HTTP 500 response.
Example Request
The following example creates a Case and associates it with a Case Lead, Client, and two user groups.
Replace <api-base-url> with the /api/v1 base URL for your Monolith environment.
See API Endpoints for the correct API base URL.
Related Documentation
Last updated
Was this helpful?