Update a Task API¶
This API allows you to update an existing task in the case management system.
| METHOD | POST |
| Endpoint | https://{{host}}/caseManagement/api/public/analytics/{{streamId}}/updateTask/{{taskId}}
|
| Content Type | application/json
|
| Authorization | auth: {{JWT}}
|
| API Scope | Case Management Configuration. |
Path Parameters¶
| PARAMETER | DESCRIPTION | TYPE |
| host | Environment URL. For example, https://platform.kore.ai/ | string, required |
| streamId | Bot identifier or Stream identifier. You can access it from the General Settings page of the bot. For example, st-084d3c5e-376a-559f-9987-a012bb2bxxxx | string, required |
| taskId | Unique identifier of the task to update. For example, ti-73acd32-0123-4114-9891-00a950aaxxxx | string, required |
Header Parameters¶
| PARAMETER | DESCRIPTION | TYPE |
| accountId | The account identifier associated with the API request. For example, 6639f7bd58c97ffac03bxxxx | string, required |
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¶
| PARAMETER | DESCRIPTION | TYPE |
| caseTmp | Unique task template identifier | string, optional |
| name | Case name | string, optional |
| lname | Lowercase version or slug of the name | string, optional |
| desc | task description | string, optional |
| tags | Array of tag strings | array, optional |
| userInfo | Info about the user who created or owns the case | object, optional |
| sessIds | Related session IDs | array, optional |
| accountId | Account identifier | string, optional |
| lid | Stream or instance, or session ID | string, optional |
| orgId | Organization identifier | string, optional |
| convIds | Related conversation IDs | array, optional |
| status | Current task status | object, optional |
| language | Task language code (for example, english) | string, optional |
| source | Source of the task (for example, rtm) | string, optional |
| conversationType | Type of conversation (expected case) | string, optional |
| fields | Custom or system field definitions and values | array, optional |
| participants | List of participant objects | array, optional |
| queues | List of queues assigned to the task | array, optional |
| priority | Priority metadata (level, color, and so on) | object, optional |
| refId | Task reference ID | string, optional |
| assigneeType | Assignment type (unassigned, queues, and so on) | string, optional |
| isActive | Whether the task is active | boolean, optional |
| taskIds | Array of associated task IDs | array, optional |
| attachments | Array of attachments | array, optional |
| feedback | Feedback data | array, optional |
| createdBy | Creator information | object, optional |
| updatedBy | Last updated by info | object, optional |
| timestampValue | Timestamp (in ms) for tracking updates | number, optional |
| activityIds | Related activity IDs | array, optional |
| commentIds | Related comment IDs | array, optional |
| resolutionCmts | Resolution comments | array, optional |
| dueDate | Task due date timestamp (in ms) | number, optional |
| isBreached | SLA breach flag | boolean, optional |
| supportCustomTasks | Indicates support for custom tasks | boolean, optional |
| channel | Channels used (for example, chat, email) | array, optional |
| createdAt | Task creation timestamp | string, optional |
| updatedAt | Last updated timestamp | string, optional |
| currAssignee | Current assigned agent information | object, optional |
| ETA | Estimated time of resolution (ISO date string) | string, optional |
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": "dummy"
},
"sessIds": [],
"accountId": "6639f7bd58c97ffac03bxxxx",
"iId": "st-084d3c5e-376a-559f-9987-a012bb2bxxxx",
"orgId": "o-85e72576-06a6-5c0b-8844-25fa0cd6xxxx",
"convIds": [],
"status": {
"_id": "sts-a3ed479-e945-4b59-a0c0-4369472axxxx",
"name": "Open",
"lname": "open",
"statusCategory": "open",
"type": "system",
"desc": "When a new case/task is created",
"isEnabled": true,
"isActive": true
},
"source": "rtm",
"conversationType": "TASK",
"fields": [
{
"_id": "fd-0c85264-e40d-48b9-ab6a-896e09adxxxx",
"show": true,
"displayName": "Due Date",
"lname": "due date",
"desc": "Date/time to complete a case",
"isEnabled": true,
"isActive": true,
"metaData": {
"type": "datetime",
"displayName": "Due Date",
"name": "dueDate",
"description": "Date/time to complete a case",
"placeholder": "Enter date",
"readOnly": false,
"tooltipText": "Date/time to complete a case"
},
"type": "system",
"required": true,
"dataType": "datetime"
},
{
"_id": "fd-9d30e02-0147-4077-9daa-c480c8d1xxxx",
"show": true,
"displayName": "Description",
"lname": "description",
"desc": "Transcription based on the conversation summary",
"isEnabled": true,
"isActive": true,
"metaData": {
"type": "textarea",
"displayName": "Description",
"name": "description",
"description": "Transcription based on the conversation summary",
"placeholder": "Enter description",
"readOnly": false,
"tooltipText": "Transcription based on the conversation summary"
},
"type": "system",
"required": true,
"dataType": "textarea"
},
{
"_id": "fd-7a49002-b492-413d-9c9d-bde3da27xxxx",
"show": true,
"displayName": "Title",
"lname": "title",
"desc": "Title of the field",
"isEnabled": true,
"isActive": true,
"metaData": {
"type": "input",
"displayName": "Title",
"name": "title",
"description": "Title of the field",
"placeholder": "Enter title",
"readOnly": false,
"tooltipText": "Title of the field"
},
"type": "system",
"required": true,
"dataType": "input"
}
],
"participants": [],
"priority": {
"_id": "pr-cad98ea-d89c-489b-acc7-e86341e5xxxx",
"name": "Medium",
"lname": "medium",
"type": "system",
"desc": "Moderate urgency",
"color": "#16A34A",
"isEnabled": true,
"isActive": true,
"score": 10
},
"refId": "TS000102",
"assigneeType": "unassigned",
"isCustTsk": false,
"isActive": true,
"attachments": [],
"feedback": [],
"createdBy": {
"name": "hi hi",
"_id": "u-9471a3c6-d950-5720-a812-fbc1ac9f4828",
"profImage": "no-avatar"
},
"updatedBy": {
"name": "hi hi",
"_id": "u-9471a3c6-d950-5720-a812-fbc1ac9fxxxx",
"profImage": "no-avatar"
},
"timestampValue": 1749032280681,
"activityIds": [],
"commentIds": [],
"resolutionCmts": [],
"isBreached": false,
"queues": [],
"channel": [],
"createdAt": "2025-06-04T10:18:00.725Z",
"updatedAt": "2025-06-04T10:24:51.612Z",
"currAssignee": {},
"ETA": ""
}