Skip to main content
PUT
/
api
/
tasks
/
{id}
/
status
Update task status
curl --request PUT \
  --url https://platform.kodexa.ai/api/tasks/{id}/status \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "statusId": "<string>"
}
'
{
  "assignee": "aSDinaTvuI8gbWludGxpZnk=",
  "assigneeId": "<string>",
  "changeSequence": 123,
  "completedDate": "2023-11-07T05:31:56Z",
  "createdOn": "2023-11-07T05:31:56Z",
  "deleteUserEmail": "<string>",
  "deleteUserId": "<string>",
  "deleted": true,
  "deletedDate": "2023-11-07T05:31:56Z",
  "description": "Review and validate all Q4 2025 invoices.",
  "dueDate": "2023-11-07T05:31:56Z",
  "id": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11",
  "locked": true,
  "metadata": {
    "dataProperties": {}
  },
  "parentTask": {},
  "parentTaskId": "<string>",
  "priority": 1,
  "project": {
    "changeSequence": 123,
    "color": "<string>",
    "createdOn": "2023-11-07T05:31:56Z",
    "dataFlow": {
      "edges": [
        {
          "id": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11",
          "properties": {},
          "source": "<string>",
          "target": "<string>"
        }
      ],
      "nodes": [
        {
          "dimensions": {
            "height": 123,
            "width": 123
          },
          "id": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11",
          "parentId": "<string>",
          "position": {
            "x": 123,
            "y": 123
          },
          "properties": {},
          "type": "<string>"
        }
      ],
      "viewPort": {
        "x": 123,
        "y": 123,
        "zoom": 123
      }
    },
    "description": "Review and validate all Q4 2025 invoices.",
    "id": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11",
    "memory": {
      "changeSequence": 123,
      "orderedDashboards": [
        "<string>"
      ],
      "recentFilters": {},
      "recentQueries": {}
    },
    "name": "<string>",
    "notes": "<string>",
    "options": {
      "dataOptions": [
        {
          "aliases": [
            "<string>"
          ],
          "default": {},
          "description": "Review and validate all Q4 2025 invoices.",
          "developerOnly": true,
          "displayProperties": {},
          "falseLabel": "<string>",
          "featureFlag": "<string>",
          "groupOptions": [
            {}
          ],
          "hint": "<string>",
          "label": "<string>",
          "listDescription": "<string>",
          "listLabel": "<string>",
          "listType": "<string>",
          "name": "<string>",
          "overviewMarkdown": "<string>",
          "possibleValues": [
            {
              "description": "Review and validate all Q4 2025 invoices.",
              "label": "<string>",
              "value": {}
            }
          ],
          "properties": {},
          "required": true,
          "showIf": "<string>",
          "showOnPopup": true,
          "subType": "<string>",
          "supportArticle": "<string>",
          "tabName": "<string>",
          "type": "<string>"
        }
      ],
      "dataProperties": {},
      "groupTaxonTypeFeatures": {},
      "options": [
        {
          "aliases": [
            "<string>"
          ],
          "default": {},
          "description": "Review and validate all Q4 2025 invoices.",
          "developerOnly": true,
          "displayProperties": {},
          "falseLabel": "<string>",
          "featureFlag": "<string>",
          "groupOptions": [
            {}
          ],
          "hint": "<string>",
          "label": "<string>",
          "listDescription": "<string>",
          "listLabel": "<string>",
          "listType": "<string>",
          "name": "<string>",
          "overviewMarkdown": "<string>",
          "possibleValues": [
            {
              "description": "Review and validate all Q4 2025 invoices.",
              "label": "<string>",
              "value": {}
            }
          ],
          "properties": {},
          "required": true,
          "showIf": "<string>",
          "showOnPopup": true,
          "subType": "<string>",
          "supportArticle": "<string>",
          "tabName": "<string>",
          "type": "<string>"
        }
      ],
      "properties": {},
      "taskOptions": {
        "showNewTask": true,
        "showTakeNext": true
      },
      "taxonTypeFeatures": {}
    },
    "organization": {
      "authGroupLink": {
        "authGroup": "<string>"
      },
      "changeSequence": 123,
      "createdOn": "2023-11-07T05:31:56Z",
      "defaultToPrivateTemplates": true,
      "description": "Review and validate all Q4 2025 invoices.",
      "enterpriseOrganization": true,
      "features": {},
      "hasImage": true,
      "id": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11",
      "memory": {
        "orderedDashboards": [
          "<string>"
        ]
      },
      "name": "<string>",
      "organizationStatus": "<string>",
      "properties": {},
      "publicAccess": true,
      "searchText": "<string>",
      "slug": "<string>",
      "stripeCustomerId": "<string>",
      "supportAccess": true,
      "supportAccessExpiresAt": "2023-11-07T05:31:56Z",
      "updatedOn": "2023-11-07T05:31:56Z",
      "uuid": "<string>"
    },
    "organizationId": "<string>",
    "owner": {
      "active": true,
      "bio": "<string>",
      "businessGroup": "<string>",
      "changeSequence": 123,
      "createdOn": "2023-11-07T05:31:56Z",
      "email": "<string>",
      "firstName": "<string>",
      "groupsJson": "<string>",
      "id": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11",
      "image": "<string>",
      "isExternallyManaged": true,
      "lastName": "<string>",
      "preferences": {
        "showOnboarding": true,
        "showScrollbars": true,
        "showWelcomeMessage": true
      },
      "roles": {
        "roles": [
          "<string>"
        ]
      },
      "rolesJson": "<string>",
      "searchText": "<string>",
      "showDeveloperTools": true,
      "title": "Review Q4 invoices",
      "updatedOn": "2023-11-07T05:31:56Z",
      "userStorage": {
        "favoriteLinks": [
          {
            "link": "<string>"
          }
        ]
      },
      "userType": "<string>",
      "uuid": "<string>"
    },
    "ownerId": "<string>",
    "projectTemplateRef": "<string>",
    "searchText": "<string>",
    "slug": "<string>",
    "status": {
      "changeSequence": 123,
      "color": "<string>",
      "createdOn": "2023-11-07T05:31:56Z",
      "icon": "<string>",
      "id": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11",
      "organization": {
        "authGroupLink": {
          "authGroup": "<string>"
        },
        "changeSequence": 123,
        "createdOn": "2023-11-07T05:31:56Z",
        "defaultToPrivateTemplates": true,
        "description": "Review and validate all Q4 2025 invoices.",
        "enterpriseOrganization": true,
        "features": {},
        "hasImage": true,
        "id": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11",
        "memory": {
          "orderedDashboards": [
            "<string>"
          ]
        },
        "name": "<string>",
        "organizationStatus": "<string>",
        "properties": {},
        "publicAccess": true,
        "searchText": "<string>",
        "slug": "<string>",
        "stripeCustomerId": "<string>",
        "supportAccess": true,
        "supportAccessExpiresAt": "2023-11-07T05:31:56Z",
        "updatedOn": "2023-11-07T05:31:56Z",
        "uuid": "<string>"
      },
      "organizationId": "<string>",
      "production": true,
      "status": "<string>",
      "updatedOn": "2023-11-07T05:31:56Z",
      "uuid": "<string>"
    },
    "statusId": "<string>",
    "statusType": "<string>",
    "templateArticleId": "<string>",
    "updatedOn": "2023-11-07T05:31:56Z",
    "uuid": "<string>"
  },
  "projectId": "<string>",
  "properties": {},
  "searchText": "<string>",
  "signal": {
    "metadata": {},
    "notes": "<string>",
    "outcome": "<string>",
    "requestedItems": [
      {}
    ]
  },
  "status": "<string>",
  "statusId": "<string>",
  "taskActivities": [
    {
      "changeSequence": 123,
      "content": "<string>",
      "createdOn": "2023-11-07T05:31:56Z",
      "detail": {
        "interpolatedValues": {},
        "type": "<string>"
      },
      "id": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11",
      "searchText": "<string>",
      "task": {},
      "taskId": "<string>",
      "updatedOn": "2023-11-07T05:31:56Z",
      "user": "aSDinaTvuI8gbWludGxpZnk=",
      "userId": "<string>",
      "uuid": "<string>"
    }
  ],
  "template": {
    "changeSequence": 123,
    "createdOn": "2023-11-07T05:31:56Z",
    "description": "Review and validate all Q4 2025 invoices.",
    "id": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11",
    "metadata": {
      "actions": [
        {
          "label": "<string>",
          "properties": {},
          "type": "<string>",
          "uuid": "<string>"
        }
      ],
      "documentFamilyGroups": [
        {
          "automaticallyAdd": true,
          "documentFamilyFilter": "<string>",
          "editable": true,
          "maxHits": 123,
          "maxPages": 123,
          "maxSize": 123,
          "name": "<string>",
          "notes": "<string>",
          "sort": "<string>",
          "titlePrompt": "<string>",
          "uniqueFilenames": true,
          "uploadOnly": true
        }
      ],
      "forms": [
        {
          "actions": [
            {
              "label": "<string>",
              "properties": {},
              "type": "<string>",
              "uuid": "<string>"
            }
          ],
          "availablePanels": {},
          "dataFormRef": "<string>",
          "properties": {}
        }
      ],
      "options": [
        {
          "aliases": [
            "<string>"
          ],
          "default": {},
          "description": "Review and validate all Q4 2025 invoices.",
          "developerOnly": true,
          "displayProperties": {},
          "falseLabel": "<string>",
          "featureFlag": "<string>",
          "hint": "<string>",
          "label": "<string>",
          "listDescription": "<string>",
          "listLabel": "<string>",
          "listType": "<string>",
          "name": "<string>",
          "overviewMarkdown": "<string>",
          "properties": {},
          "required": true,
          "showIf": "<string>",
          "showOnPopup": true,
          "subType": "<string>",
          "supportArticle": "<string>",
          "tabName": "<string>",
          "type": "<string>"
        }
      ],
      "priority": 1,
      "properties": {},
      "workspaceId": "<string>"
    },
    "name": "<string>",
    "planTemplate": {
      "items": [
        {
          "allowedOutcomes": [
            "<string>"
          ],
          "approvalCriteria": {},
          "approverRole": "<string>",
          "condition": {},
          "dependsOn": [
            "<string>"
          ],
          "hideLock": true,
          "maxStepsToInsert": 123,
          "moduleRef": "<string>",
          "name": "<string>",
          "options": {},
          "plannerContext": {},
          "taskData": {
            "actions": [
              {
                "label": "<string>",
                "properties": {},
                "type": "<string>",
                "uuid": "<string>"
              }
            ],
            "description": "Review and validate all Q4 2025 invoices.",
            "documentFamilyGroups": [
              {
                "automaticallyAdd": true,
                "documentFamilyFilter": "<string>",
                "editable": true,
                "maxHits": 123,
                "maxPages": 123,
                "maxSize": 123,
                "name": "<string>",
                "notes": "<string>",
                "sort": "<string>",
                "titlePrompt": "<string>",
                "uniqueFilenames": true,
                "uploadOnly": true
              }
            ],
            "forms": [
              {
                "actions": [
                  {
                    "label": "<string>",
                    "properties": {},
                    "type": "<string>",
                    "uuid": "<string>"
                  }
                ],
                "availablePanels": {},
                "dataFormRef": "<string>",
                "properties": {}
              }
            ],
            "panelProperties": {},
            "priority": 1,
            "properties": {},
            "title": "Review Q4 invoices"
          },
          "taskStatusSlug": "<string>",
          "taskTemplateRef": "<string>"
        }
      ]
    },
    "planned": true,
    "project": {
      "changeSequence": 123,
      "color": "<string>",
      "createdOn": "2023-11-07T05:31:56Z",
      "dataFlow": {
        "edges": [
          {
            "id": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11",
            "properties": {},
            "source": "<string>",
            "target": "<string>"
          }
        ],
        "nodes": [
          {
            "dimensions": {
              "height": 123,
              "width": 123
            },
            "id": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11",
            "parentId": "<string>",
            "position": {
              "x": 123,
              "y": 123
            },
            "properties": {},
            "type": "<string>"
          }
        ],
        "viewPort": {
          "x": 123,
          "y": 123,
          "zoom": 123
        }
      },
      "description": "Review and validate all Q4 2025 invoices.",
      "id": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11",
      "memory": {
        "changeSequence": 123,
        "orderedDashboards": [
          "<string>"
        ],
        "recentFilters": {},
        "recentQueries": {}
      },
      "name": "<string>",
      "notes": "<string>",
      "options": {
        "dataOptions": [
          {
            "aliases": [
              "<string>"
            ],
            "default": {},
            "description": "Review and validate all Q4 2025 invoices.",
            "developerOnly": true,
            "displayProperties": {},
            "falseLabel": "<string>",
            "featureFlag": "<string>",
            "groupOptions": [
              {}
            ],
            "hint": "<string>",
            "label": "<string>",
            "listDescription": "<string>",
            "listLabel": "<string>",
            "listType": "<string>",
            "name": "<string>",
            "overviewMarkdown": "<string>",
            "possibleValues": [
              {
                "description": "Review and validate all Q4 2025 invoices.",
                "label": "<string>",
                "value": {}
              }
            ],
            "properties": {},
            "required": true,
            "showIf": "<string>",
            "showOnPopup": true,
            "subType": "<string>",
            "supportArticle": "<string>",
            "tabName": "<string>",
            "type": "<string>"
          }
        ],
        "dataProperties": {},
        "groupTaxonTypeFeatures": {},
        "options": [
          {
            "aliases": [
              "<string>"
            ],
            "default": {},
            "description": "Review and validate all Q4 2025 invoices.",
            "developerOnly": true,
            "displayProperties": {},
            "falseLabel": "<string>",
            "featureFlag": "<string>",
            "groupOptions": [
              {}
            ],
            "hint": "<string>",
            "label": "<string>",
            "listDescription": "<string>",
            "listLabel": "<string>",
            "listType": "<string>",
            "name": "<string>",
            "overviewMarkdown": "<string>",
            "possibleValues": [
              {
                "description": "Review and validate all Q4 2025 invoices.",
                "label": "<string>",
                "value": {}
              }
            ],
            "properties": {},
            "required": true,
            "showIf": "<string>",
            "showOnPopup": true,
            "subType": "<string>",
            "supportArticle": "<string>",
            "tabName": "<string>",
            "type": "<string>"
          }
        ],
        "properties": {},
        "taskOptions": {
          "showNewTask": true,
          "showTakeNext": true
        },
        "taxonTypeFeatures": {}
      },
      "organization": {
        "authGroupLink": {
          "authGroup": "<string>"
        },
        "changeSequence": 123,
        "createdOn": "2023-11-07T05:31:56Z",
        "defaultToPrivateTemplates": true,
        "description": "Review and validate all Q4 2025 invoices.",
        "enterpriseOrganization": true,
        "features": {},
        "hasImage": true,
        "id": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11",
        "memory": {
          "orderedDashboards": [
            "<string>"
          ]
        },
        "name": "<string>",
        "organizationStatus": "<string>",
        "properties": {},
        "publicAccess": true,
        "searchText": "<string>",
        "slug": "<string>",
        "stripeCustomerId": "<string>",
        "supportAccess": true,
        "supportAccessExpiresAt": "2023-11-07T05:31:56Z",
        "updatedOn": "2023-11-07T05:31:56Z",
        "uuid": "<string>"
      },
      "organizationId": "<string>",
      "owner": {
        "active": true,
        "bio": "<string>",
        "businessGroup": "<string>",
        "changeSequence": 123,
        "createdOn": "2023-11-07T05:31:56Z",
        "email": "<string>",
        "firstName": "<string>",
        "groupsJson": "<string>",
        "id": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11",
        "image": "<string>",
        "isExternallyManaged": true,
        "lastName": "<string>",
        "preferences": {
          "showOnboarding": true,
          "showScrollbars": true,
          "showWelcomeMessage": true
        },
        "roles": {
          "roles": [
            "<string>"
          ]
        },
        "rolesJson": "<string>",
        "searchText": "<string>",
        "showDeveloperTools": true,
        "title": "Review Q4 invoices",
        "updatedOn": "2023-11-07T05:31:56Z",
        "userStorage": {
          "favoriteLinks": [
            {
              "link": "<string>"
            }
          ]
        },
        "userType": "<string>",
        "uuid": "<string>"
      },
      "ownerId": "<string>",
      "projectTemplateRef": "<string>",
      "searchText": "<string>",
      "slug": "<string>",
      "status": {
        "changeSequence": 123,
        "color": "<string>",
        "createdOn": "2023-11-07T05:31:56Z",
        "icon": "<string>",
        "id": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11",
        "organization": {
          "authGroupLink": {
            "authGroup": "<string>"
          },
          "changeSequence": 123,
          "createdOn": "2023-11-07T05:31:56Z",
          "defaultToPrivateTemplates": true,
          "description": "Review and validate all Q4 2025 invoices.",
          "enterpriseOrganization": true,
          "features": {},
          "hasImage": true,
          "id": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11",
          "memory": {
            "orderedDashboards": [
              "<string>"
            ]
          },
          "name": "<string>",
          "organizationStatus": "<string>",
          "properties": {},
          "publicAccess": true,
          "searchText": "<string>",
          "slug": "<string>",
          "stripeCustomerId": "<string>",
          "supportAccess": true,
          "supportAccessExpiresAt": "2023-11-07T05:31:56Z",
          "updatedOn": "2023-11-07T05:31:56Z",
          "uuid": "<string>"
        },
        "organizationId": "<string>",
        "production": true,
        "status": "<string>",
        "updatedOn": "2023-11-07T05:31:56Z",
        "uuid": "<string>"
      },
      "statusId": "<string>",
      "statusType": "<string>",
      "templateArticleId": "<string>",
      "updatedOn": "2023-11-07T05:31:56Z",
      "uuid": "<string>"
    },
    "projectId": "<string>",
    "slug": "<string>",
    "updatedOn": "2023-11-07T05:31:56Z",
    "uuid": "<string>"
  },
  "templateId": "<string>",
  "title": "Review Q4 invoices",
  "updatedOn": "2023-11-07T05:31:56Z",
  "uuid": "<string>"
}

Authorizations

​
x-api-key
string
header
required

API key for authentication. Create one from the Kodexa platform UI under Settings > Access Tokens.

Path Parameters

​
id
string<uuid>
required

Unique identifier (UUID) of the resource.

Body

application/json
​
statusId
string

ID of the new task status.

Response

Updated task

A task represents a unit of work in a document review workflow, with an assignee, status, and due date.

​
assignee
string<byte>
​
assigneeId
string | null

ID of the user assigned to this task.

​
changeSequence
integer<int32>

Optimistic locking version number.

​
completedDate
string<date-time> | null

Date when the task was completed.

​
createdOn
string<date-time>

Timestamp when the task was created.

​
deleteUserEmail
string

Email of the user who deleted the task.

​
deleteUserId
string

ID of the user who deleted the task.

​
deleted
boolean

Whether the task has been soft-deleted.

​
deletedDate
string<date-time> | null

Timestamp when the task was soft-deleted.

​
description
string

Detailed description of the task.

Example:

"Review and validate all Q4 2025 invoices."

​
dueDate
string<date-time> | null

Due date for the task.

​
id
string

Unique identifier (UUID) for the task.

Example:

"a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11"

​
locked
boolean

Whether the task is locked for editing.

​
metadata
object

Task metadata including custom fields.

​
parentTask
object
​
parentTaskId
string | null

ID of the parent task (for sub-tasks).

​
priority
integer<int32> | null

Priority level of the task (lower number = higher priority).

Example:

1

​
project
object
​
projectId
string | null

ID of the project this task belongs to.

​
properties
object

Task properties for UI state and configuration.

​
searchText
string

Full-text searchable representation of the task.

​
signal
object

Signal from human reviewer for plan-aware task completion.

​
status
string
​
statusId
string | null

ID of the current task status.

​
taskActivities
object[]
​
template
object
​
templateId
string | null

ID of the task template used.

​
title
string

Title of the task.

Example:

"Review Q4 invoices"

​
updatedOn
string<date-time>

Timestamp when the task was last updated.

​
uuid
string

Secondary UUID identifier.