Upload Case

Creates a new case for the specified case type, or updates an existing one, and optionally uploads files.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Creates a new case under the specified case type and optionally uploads document files to it. If a case_id is provided, the existing case is used instead of creating a new one.

Supported File Extensions: jpg, jpeg, png, tiff, pdf , xlsx

Supported Document Types:
You can retrieve the list of supported document types from the List Agents endpoint. The specified doctype must be enabled for your account and configured in the case type's document types.

Workflow behavior: By default, the case type's workflow is triggered automatically after the upload completes. Set trigger_workflow to false to skip workflow execution.

Rate limits: This endpoint allows a maximum of 10 requests per second, with up to 10 documents per request.

Body Params
string
required

The unique identifier of the case type to create the case under. The case type must exist and not be disabled. You can obtain this value from the List Agents endpoint.

files
array of files

One or more files to upload to the case. Omit this field to create or update a case without uploading files.

string

The unique identifier of an existing case to use instead of creating a new one. If omitted, a new case is created.

string

An external reference ID for the case from your system. Use this to map the case to a record in your own application.

string

Display name for the case.

string

The stage to assign to the case on creation. You can obtain stage IDs from the Get Case Type Details endpoint.

string

The user ID to assign the case to.

string

The document type for the uploaded files.

string
enum
Defaults to true

Whether to trigger the case type's workflow after the upload completes. Defaults to true.

Allowed:
string

Additional metadata for the case from your system. Store any extra information you want associated with this case.

string

Initialize case fields values while uploading a case. By default case field values are None. Ex: {"casefield_id1": "value"}

string
Defaults to published

Workflow Run version. "published" version (default) runs the case on latest published workflow version; "draft" version runs the case on last saved draft version of workflow.

Headers
string
required

API key used for authentication. You can find your API key in your account settings.

Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json