Skip to main content

Documentation Index

Fetch the complete documentation index at: https://koreai.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Back to Case Management API List Updates an existing case in the case management system.
FieldValue
MethodPOST
Endpointhttps://{{host}}/caseManagement/api/public/analytics/{{streamId}}/updateCase/{{caseId}}
Content Typeapplication/json
Authorizationauth: {{JWT}} See How to generate the JWT Token.
API ScopeCase Management Configuration

Path Parameters

ParameterRequiredDescription
hostRequiredEnvironment URL. For example, https://platform.kore.ai.
streamIdRequiredBot identifier or Stream identifier. Access it from the General Settings page of the bot. For example, st-084d3c5e-376a-559f-9987-a012bb2bxxxx.
caseIdRequiredUnique identifier of the case to update. For example, ci-b4eaa6e-b3d9-4bb3-ae54-bb043b4axxxx.

Header Parameters

ParameterRequiredDescription
accountIdRequiredThe account identifier associated with the API request. For example, 6639f7bd58c97ffac03bxxxx.

Sample Request

curl --location 'https://{{host}}/caseManagement/api/public/analytics/{{streamId}}/updateCase/{{caseId}}' \
--header 'sec-ch-ua: "Google Chrome";v="123", "Not:A-Brand";v="8", "Chromium";v="123"' \
--header 'AccountId: {{accountId}}' \
--header 'client-app: unified' \
--header 'X-Timezone-Offset: -330' \
--header 'sec-ch-ua-mobile: ?0' \
--header 'auth: {{jwt-code}}' \
--header 'state: configured' \
--header 'Iid: st-084d3c5e-376a-559f-9987-a012bb2bxxxx' \
--header 'Content-Type: application/json;charset=UTF-8' \
--header 'Accept: application/json, text/plain, */*' \
--header 'User-Agent: Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/123.0.0.0 Safari/537.36' \
--header 'bot-language: en' \
--header 'app-language: en' \
--header 'Referer: http://localhost/builder/app/welcomeflows' \
--header 'sec-ch-ua-platform: "Linux"' \
--data-raw '{
  "_id": "ci-1a634e1-3d97-427e-8b23-9b7b0a40xxxx",
  "caseTmp": "one",
  "name": "case one",
  "lname": "case one",
  "desc": "this is case one",
  "tags": [],
  "userInfo": {
    "_id": "u-d0db86ae-8a26-51dd-a6d6-5d531c39xxxx",
    "name": "",
    "emailId": "john.doe@example.com"
  },
  "accountId": "{{accountId}}",
  "iId": "st-5393141c-723b-579d-8265-27dd9b7fxxxx",
  "orgId": "o-a55026c9-2abd-5503-b212-5fba600axxxx",
  "status": {
    "_id": "sts-47a7230-2a07-4b84-879b-e792542cxxxx",
    "name": "Open",
    "lname": "open",
    "statusCategory": "open"
  },
  "priority": {
    "_id": "pr-9d1a24a-1385-45e9-818b-295eab5bxxxx",
    "name": "Medium",
    "lname": "medium",
    "desc": "Moderate urgency"
  },
  "refId": "CS000100",
  "isActive": true,
  "dueDate": 1748491380000
}'

Request Body Parameters

ParameterRequiredTypeDescription
caseTmpOptionalStringUnique case template identifier.
nameOptionalStringCase name.
lnameOptionalStringLowercase version or slug of the name.
descOptionalStringCase description.
tagsOptionalArrayArray of tag strings.
userInfoOptionalObjectInformation about the user who created or owns the case.
sessIdsOptionalArrayRelated session IDs.
accountIdOptionalStringAccount identifier.
lidOptionalStringStream, instance, or session ID.
orgIdOptionalStringOrganization identifier.
convIdsOptionalArrayRelated conversation IDs.
statusOptionalObjectCurrent case status.
languageOptionalStringCase language code. For example, english.
sourceOptionalStringSource of the case. For example, rtm.
conversationTypeOptionalStringType of conversation. Expected value: case.
fieldsOptionalArrayCustom or system field definitions and values.
participantsOptionalArrayList of participant objects.
queuesOptionalArrayList of queues assigned to the case.
priorityOptionalObjectPriority metadata, including level and color.
refIdOptionalStringCase reference ID.
assigneeTypeOptionalStringAssignment type. For example, unassigned, queues.
isActiveOptionalBooleanWhether the case is active.
taskIdsOptionalArrayArray of associated task IDs.
attachmentsOptionalArrayArray of attachments.
feedbackOptionalArrayFeedback data.
createdByOptionalObjectCreator information.
updatedByOptionalObjectLast updated by information.
timestampValueOptionalNumberTimestamp in milliseconds for tracking updates.
activityIdsOptionalArrayRelated activity IDs.
commentIdsOptionalArrayRelated comment IDs.
resolutionCmtsOptionalArrayResolution comments.
dueDateOptionalNumberCase due date timestamp in milliseconds.
isBreachedOptionalBooleanSLA breach flag.
supportCustomTasksOptionalBooleanIndicates support for custom tasks.
channelOptionalArrayChannels used. For example, chat, email.
createdAtOptionalStringCase creation timestamp.
updatedAtOptionalStringLast updated timestamp.
currAssigneeOptionalObjectCurrent assigned agent information.
ETAOptionalStringEstimated time of resolution in ISO date string format.

Sample Response

{
  "_id": "ci-b4eaa6e-b3d9-4bb3-ae54-bb043b4axxxx",
  "caseTmp": "CaseTemplate1",
  "name": "This is demo case",
  "lname": "this is demo case",
  "userInfo": {
    "_id": "u-fd371c0a-3168-5a02-83dd-f4ba5597xxxx",
    "name": "john",
    "emailId": "john.doe@example.com"
  },
  "accountId": "{{accountId}}",
  "status": {
    "_id": "sts-a3ed479-e945-4b59-a0c0-4369472axxxx",
    "name": "Open",
    "statusCategory": "open"
  },
  "priority": {
    "_id": "pr-cad98ea-d89c-489b-acc7-e86341e5xxxx",
    "name": "Medium",
    "desc": "Moderate urgency"
  },
  "refId": "CS00xxxx",
  "assigneeType": "queues",
  "isActive": true,
  "createdAt": "2025-06-04T08:17:35.419Z",
  "updatedAt": "2025-06-04T09:40:09.323Z",
  "ETA": ""
}