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 task in the case management system.
FieldValue
MethodPOST
Endpointhttps://{{host}}/caseManagement/api/public/analytics/{{streamId}}/updateTask/{{taskId}}
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 or Stream identifier from the bot’s General Settings. For example, st-084d3c5e-376a-559f-xxxx-a012bbxxxxxx.
taskIdRequiredUnique task identifier. For example, ti-73acd32-0123-xxxx-9891-00a950xxxxxx.

​
Header Parameters

ParameterRequiredDescription
accountIdRequiredAccount identifier associated with the API request. For example, 6639f7bd5xxxxffac03bxxxx.

​
Sample Request

curl --location 'https://{{host}}/caseManagement/api/public/analytics/{{streamId}}/updateTask/{{taskId}}' \
--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 '{
    "name": "Task Testing"
}'

​
Request Body Parameters

ParameterRequiredTypeDescription
caseTmpOptionalStringUnique task template identifier.
nameOptionalStringTask name.
lnameOptionalStringLowercase version or slug of the name.
descOptionalStringTask description.
tagsOptionalArrayArray of tag strings.
userInfoOptionalObjectUser information for the user who created or owns the task.
sessIdsOptionalArrayRelated session IDs.
accountIdOptionalStringAccount identifier.
lidOptionalStringStream, instance, or session ID.
orgIdOptionalStringOrganization identifier.
convIdsOptionalArrayRelated conversation IDs.
statusOptionalObjectCurrent task status.
languageOptionalStringTask language code. For example, english.
sourceOptionalStringSource of the task. For example, rtm.
conversationTypeOptionalStringType of conversation.
fieldsOptionalArrayCustom or system field definitions and values.
participantsOptionalArrayList of participants.
queuesOptionalArrayAssigned queues.
priorityOptionalObjectPriority metadata.
refIdOptionalStringTask reference ID.
assigneeTypeOptionalStringAssignment type.
isActiveOptionalBooleanWhether the task 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.
dueDateOptionalNumberDue date timestamp in milliseconds.
isBreachedOptionalBooleanSLA breach flag.
supportCustomTasksOptionalBooleanSupport for custom tasks.
channelOptionalArrayChannels used. For example, chat, email.
createdAtOptionalStringTask creation timestamp.
updatedAtOptionalStringLast updated timestamp.
currAssigneeOptionalObjectCurrent assigned agent.
ETAOptionalStringEstimated resolution time in ISO format.

​
Sample Response

{
    "_id": "ti-73acd32-0123-4114-9891-00a950aaxxxx",
    "caseId": "ci-31d9184-d64d-42d9-8c75-5edba531xxxx",
    "caseRefId": "CS00xxxx",
    "taskTmp": "jbhk",
    "name": "Task Testing",
    "lname": "task testing",
    "tags": [],
    "userInfo": {
        "_id": "u-fd371c0a-3168-5a02-83dd-f4ba5597xxxx",
        "name": "John"
    },
    ...
    "ETA": ""
}