Update task status

Updates the status of the specified task.

PUT /api/tasks/{id}/status

Update task status

cURL

curl --request PUT \
  --url https://platform.kodexa.ai/api/tasks/{id}/status \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "statusSlug": "<string>"
}
'

200

{
  "assignee": {
    "active": true,
    "bio": "<string>",
    "businessGroup": "<string>",
    "changeSequence": 123,
    "createdOn": "2023-11-07T05:31:56Z",
    "email": "<string>",
    "firstName": "<string>",
    "groupsJson": "<string>",
    "id": "<string>",
    "image": "<string>",
    "invited": true,
    "isExternallyManaged": true,
    "lastName": "<string>",
    "preferences": {
      "showOnboarding": true,
      "showScrollbars": true,
      "showWelcomeMessage": true
    },
    "rolesJson": "<string>",
    "searchText": "<string>",
    "security": {
      "roles": [
        "<string>"
      ]
    },
    "showDeveloperTools": true,
    "title": "<string>",
    "updatedOn": "2023-11-07T05:31:56Z",
    "userHash": "<string>",
    "userStorage": {
      "favoriteLinks": [
        {
          "link": "<string>"
        }
      ]
    },
    "userType": "<string>",
    "uuid": "<string>"
  },
  "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": {
    "actions": [
      {
        "label": "<string>",
        "properties": {},
        "slug": "<string>",
        "type": "<string>",
        "uuid": "<string>"
      }
    ],
    "dataProperties": {}
  },
  "parentTask": null,
  "parentTaskId": "<string>",
  "plan": {
    "activityPlanId": "<string>",
    "changeSequence": 123,
    "completedOn": "2023-11-07T05:31:56Z",
    "createdOn": "2023-11-07T05:31:56Z",
    "currentSequence": 123,
    "deleteUserEmail": "<string>",
    "deleteUserId": "<string>",
    "deleted": true,
    "deletedDate": "2023-11-07T05:31:56Z",
    "id": "<string>",
    "lifecycleState": "<string>",
    "metadata": null,
    "organization": {
      "authGroupLink": {
        "authGroup": "<string>"
      },
      "changeSequence": 123,
      "createdOn": "2023-11-07T05:31:56Z",
      "defaultToPrivateTemplates": true,
      "description": "Document processing organization for Acme Corp.",
      "enterpriseOrganization": true,
      "features": {},
      "hasImage": true,
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "memory": {
        "orderedDashboards": [
          "<string>"
        ]
      },
      "name": "Acme Corp",
      "organizationStatus": "ACTIVE",
      "properties": {},
      "publicAccess": true,
      "searchText": "<string>",
      "slug": "acme-corp",
      "stripeCustomerId": "<string>",
      "supportAccess": true,
      "supportAccessExpiresAt": "2023-11-07T05:31:56Z",
      "updatedOn": "2023-11-07T05:31:56Z",
      "uuid": "550e8400e29b41d4a716446655440000",
      "archived": true
    },
    "organizationId": "<string>",
    "priority": 123,
    "projectId": "<string>",
    "startedOn": "2023-11-07T05:31:56Z",
    "title": "<string>",
    "triggerKind": "<string>",
    "updatedOn": "2023-11-07T05:31:56Z",
    "uuid": "<string>",
    "version": 123,
    "activityPlanSlug": "<string>",
    "badges": null,
    "candidateKnowledgeSets": [
      {
        "id": "<string>",
        "name": "<string>",
        "slug": "<string>",
        "status": "<string>",
        "currentSnapshotId": "<string>",
        "openQuestions": null,
        "projectId": "<string>",
        "updatedOn": "2023-11-07T05:31:56Z"
      }
    ],
    "completedWorkUnits": 123,
    "description": "<string>",
    "documentFamilies": [
      {
        "id": "<string>",
        "path": "<string>"
      }
    ],
    "errorDetails": "<string>",
    "failedWorkUnits": 123,
    "inputs": null,
    "knowledgeAgent": true,
    "knowledgeFeatures": [
      {
        "id": "<string>",
        "slug": "<string>",
        "featureTypeColor": "<string>",
        "featureTypeIcon": "<string>",
        "featureTypeId": "<string>",
        "featureTypeName": "<string>",
        "featureTypeSlug": "<string>"
      }
    ],
    "parentActivityId": "<string>",
    "replacedByActivityId": "<string>",
    "runningWorkUnits": 123,
    "startedByIntakeId": "<string>",
    "startedByTriggerId": "<string>",
    "steps": [
      {
        "activityId": "<string>",
        "changeSequence": 123,
        "completedOn": "2023-11-07T05:31:56Z",
        "conditionExpression": null,
        "createdOn": "2023-11-07T05:31:56Z",
        "errorDetails": null,
        "id": "<string>",
        "insertedAt": "2023-11-07T05:31:56Z",
        "insertedById": "<string>",
        "name": "<string>",
        "organization": {
          "authGroupLink": {
            "authGroup": "<string>"
          },
          "changeSequence": 123,
          "createdOn": "2023-11-07T05:31:56Z",
          "defaultToPrivateTemplates": true,
          "description": "Document processing organization for Acme Corp.",
          "enterpriseOrganization": true,
          "features": {},
          "hasImage": true,
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "memory": {
            "orderedDashboards": [
              "<string>"
            ]
          },
          "name": "Acme Corp",
          "organizationStatus": "ACTIVE",
          "properties": {},
          "publicAccess": true,
          "searchText": "<string>",
          "slug": "acme-corp",
          "stripeCustomerId": "<string>",
          "supportAccess": true,
          "supportAccessExpiresAt": "2023-11-07T05:31:56Z",
          "updatedOn": "2023-11-07T05:31:56Z",
          "uuid": "550e8400e29b41d4a716446655440000",
          "archived": true
        },
        "organizationId": "<string>",
        "sequence": 123,
        "startedOn": "2023-11-07T05:31:56Z",
        "status": "<string>",
        "type": "<string>",
        "updatedOn": "2023-11-07T05:31:56Z",
        "uuid": "<string>",
        "agentId": "<string>",
        "agentRuntimeId": "<string>",
        "agentSessionId": "<string>",
        "approvalCriteria": null,
        "approvalOutcome": "<string>",
        "approverRole": "<string>",
        "bridgeActions": null,
        "bridgeResult": null,
        "bypass": true,
        "childTaskId": "<string>",
        "completedActionUuid": "<string>",
        "completedDocFamilyIds": null,
        "currentDocFamilyId": "<string>",
        "dependsOn": [
          {
            "id": "<string>",
            "actionUuid": "<string>",
            "awaitOnly": true
          }
        ],
        "description": "<string>",
        "disableCache": true,
        "endpointName": "<string>",
        "enrichment": null,
        "executionId": "<string>",
        "includeDocument": null,
        "joinPolicy": "<string>",
        "llmModelName": "<string>",
        "logGroup": "<string>",
        "logStream": "<string>",
        "mappedOutput": null,
        "maxParallel": 123,
        "maxStepsToInsert": 123,
        "metadata": null,
        "moduleRef": "<string>",
        "moduleRefs": null,
        "options": null,
        "outputMapping": null,
        "perDocument": true,
        "plannerContext": null,
        "prompt": "<string>",
        "promptActions": null,
        "promptBody": "<string>",
        "promptRendered": "<string>",
        "promptResult": null,
        "promptTemplateRef": "<string>",
        "promptVariables": null,
        "requestBody": null,
        "requestHeaders": null,
        "requestPath": null,
        "requestQuery": null,
        "requestScript": "<string>",
        "result": null,
        "scriptActions": null,
        "scriptBody": "<string>",
        "scriptResult": null,
        "scriptSidecars": null,
        "serviceBridgeRef": "<string>",
        "setDocumentStatus": "<string>",
        "skipReason": "<string>",
        "slug": "<string>",
        "taskData": null,
        "taskStatusSlug": "<string>",
        "taskTemplateRef": "<string>",
        "timeoutSeconds": 123,
        "treatAsError": "<string>",
        "waitForCompletion": true
      }
    ],
    "totalWorkUnits": 123,
    "triggerMetadata": null
  },
  "priority": 1,
  "project": {
    "changeSequence": 123,
    "color": "#4A90D9",
    "createdOn": "2023-11-07T05:31:56Z",
    "dataFlow": {
      "edges": [
        {
          "id": "<string>",
          "properties": {},
          "source": "<string>",
          "target": "<string>"
        }
      ],
      "nodes": [
        {
          "dimensions": {
            "height": 123,
            "width": 123
          },
          "id": "<string>",
          "parentId": "<string>",
          "position": {
            "x": 123,
            "y": 123
          },
          "properties": {},
          "type": "<string>"
        }
      ],
      "viewPort": {
        "x": 123,
        "y": 123,
        "zoom": 123
      }
    },
    "description": "Automated invoice processing pipeline.",
    "documentStatuses": [
      {
        "changeSequence": 123,
        "color": "<string>",
        "createdOn": "2023-11-07T05:31:56Z",
        "icon": "<string>",
        "id": "<string>",
        "projectId": "<string>",
        "slug": "<string>",
        "status": "<string>",
        "statusType": "UNRESOLVED",
        "updatedOn": "2023-11-07T05:31:56Z",
        "uuid": "<string>",
        "project": null
      }
    ],
    "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "memory": {
      "changeSequence": 123,
      "orderedDashboards": [
        "<string>"
      ],
      "recentFilters": {},
      "recentQueries": {}
    },
    "name": "Invoice Processing",
    "notes": "<string>",
    "options": {
      "companion": {
        "agentRuntimeRef": "<string>",
        "moduleRefs": [
          "<string>"
        ],
        "prompt": "<string>"
      },
      "dataOptions": [
        {
          "aliases": [
            "<string>"
          ],
          "default": "<unknown>",
          "description": "<string>",
          "developerOnly": true,
          "displayProperties": {},
          "falseLabel": "<string>",
          "featureFlag": "<string>",
          "groupOptions": "<array>",
          "hint": "<string>",
          "label": "<string>",
          "listDescription": "<string>",
          "listLabel": "<string>",
          "listType": "<string>",
          "name": "<string>",
          "overviewMarkdown": "<string>",
          "possibleValues": [
            {
              "description": "<string>",
              "label": "<string>",
              "value": "<unknown>"
            }
          ],
          "properties": {},
          "required": true,
          "showIf": "<string>",
          "showOnPopup": true,
          "subType": "<string>",
          "supportArticle": "<string>",
          "tabName": "<string>",
          "type": "<string>"
        }
      ],
      "dataProperties": {},
      "executionPolicy": {
        "backoffBaseSeconds": 123,
        "backoffStrategy": "<string>",
        "maxAttempts": 123,
        "onExhausted": "<string>",
        "timeoutSeconds": 123
      },
      "groupTaxonTypeFeatures": {},
      "options": [
        {
          "aliases": [
            "<string>"
          ],
          "default": "<unknown>",
          "description": "<string>",
          "developerOnly": true,
          "displayProperties": {},
          "falseLabel": "<string>",
          "featureFlag": "<string>",
          "groupOptions": "<array>",
          "hint": "<string>",
          "label": "<string>",
          "listDescription": "<string>",
          "listLabel": "<string>",
          "listType": "<string>",
          "name": "<string>",
          "overviewMarkdown": "<string>",
          "possibleValues": [
            {
              "description": "<string>",
              "label": "<string>",
              "value": "<unknown>"
            }
          ],
          "properties": {},
          "required": true,
          "showIf": "<string>",
          "showOnPopup": true,
          "subType": "<string>",
          "supportArticle": "<string>",
          "tabName": "<string>",
          "type": "<string>"
        }
      ],
      "properties": {},
      "taskOptions": {
        "showNewTask": true
      },
      "taxonTypeFeatures": {}
    },
    "organization": {
      "authGroupLink": {
        "authGroup": "<string>"
      },
      "changeSequence": 123,
      "createdOn": "2023-11-07T05:31:56Z",
      "defaultToPrivateTemplates": true,
      "description": "Document processing organization for Acme Corp.",
      "enterpriseOrganization": true,
      "features": {},
      "hasImage": true,
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "memory": {
        "orderedDashboards": [
          "<string>"
        ]
      },
      "name": "Acme Corp",
      "organizationStatus": "ACTIVE",
      "properties": {},
      "publicAccess": true,
      "searchText": "<string>",
      "slug": "acme-corp",
      "stripeCustomerId": "<string>",
      "supportAccess": true,
      "supportAccessExpiresAt": "2023-11-07T05:31:56Z",
      "updatedOn": "2023-11-07T05:31:56Z",
      "uuid": "550e8400e29b41d4a716446655440000",
      "archived": true
    },
    "organizationId": "<string>",
    "owner": {
      "active": true,
      "bio": "<string>",
      "businessGroup": "<string>",
      "changeSequence": 123,
      "createdOn": "2023-11-07T05:31:56Z",
      "email": "<string>",
      "firstName": "<string>",
      "groupsJson": "<string>",
      "id": "<string>",
      "image": "<string>",
      "invited": true,
      "isExternallyManaged": true,
      "lastName": "<string>",
      "preferences": {
        "showOnboarding": true,
        "showScrollbars": true,
        "showWelcomeMessage": true
      },
      "rolesJson": "<string>",
      "searchText": "<string>",
      "security": {
        "roles": [
          "<string>"
        ]
      },
      "showDeveloperTools": true,
      "title": "<string>",
      "updatedOn": "2023-11-07T05:31:56Z",
      "userHash": "<string>",
      "userStorage": {
        "favoriteLinks": [
          {
            "link": "<string>"
          }
        ]
      },
      "userType": "<string>",
      "uuid": "<string>"
    },
    "ownerId": "<string>",
    "projectTemplateRef": "<string>",
    "searchText": "<string>",
    "slug": "invoice-processing",
    "status": {
      "changeSequence": 123,
      "color": "<string>",
      "createdOn": "2023-11-07T05:31:56Z",
      "icon": "<string>",
      "id": "<string>",
      "organization": {
        "authGroupLink": {
          "authGroup": "<string>"
        },
        "changeSequence": 123,
        "createdOn": "2023-11-07T05:31:56Z",
        "defaultToPrivateTemplates": true,
        "description": "Document processing organization for Acme Corp.",
        "enterpriseOrganization": true,
        "features": {},
        "hasImage": true,
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "memory": {
          "orderedDashboards": [
            "<string>"
          ]
        },
        "name": "Acme Corp",
        "organizationStatus": "ACTIVE",
        "properties": {},
        "publicAccess": true,
        "searchText": "<string>",
        "slug": "acme-corp",
        "stripeCustomerId": "<string>",
        "supportAccess": true,
        "supportAccessExpiresAt": "2023-11-07T05:31:56Z",
        "updatedOn": "2023-11-07T05:31:56Z",
        "uuid": "550e8400e29b41d4a716446655440000",
        "archived": true
      },
      "organizationId": "<string>",
      "production": true,
      "status": "<string>",
      "updatedOn": "2023-11-07T05:31:56Z",
      "uuid": "<string>"
    },
    "statusId": "<string>",
    "statusType": "ACTIVE",
    "templateArticleId": "<string>",
    "updatedOn": "2023-11-07T05:31:56Z",
    "uuid": "7c9e667974254de944be07fc1f90ae7"
  },
  "projectId": "<string>",
  "properties": {},
  "searchText": "<string>",
  "signal": {
    "metadata": {},
    "notes": "<string>",
    "outcome": "APPROVED",
    "requestedItems": [
      {}
    ]
  },
  "taskActivities": [
    {
      "changeSequence": 123,
      "content": "<string>",
      "createdOn": "2023-11-07T05:31:56Z",
      "detail": {
        "interpolatedValues": {},
        "type": "TASK_CREATED"
      },
      "id": "<string>",
      "searchText": "<string>",
      "task": null,
      "taskId": "<string>",
      "updatedOn": "2023-11-07T05:31:56Z",
      "user": null,
      "userId": "<string>",
      "uuid": "<string>"
    }
  ],
  "team": {
    "changeSequence": 123,
    "createdOn": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "id": "<string>",
    "name": "<string>",
    "organization": {
      "authGroupLink": {
        "authGroup": "<string>"
      },
      "changeSequence": 123,
      "createdOn": "2023-11-07T05:31:56Z",
      "defaultToPrivateTemplates": true,
      "description": "Document processing organization for Acme Corp.",
      "enterpriseOrganization": true,
      "features": {},
      "hasImage": true,
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "memory": {
        "orderedDashboards": [
          "<string>"
        ]
      },
      "name": "Acme Corp",
      "organizationStatus": "ACTIVE",
      "properties": {},
      "publicAccess": true,
      "searchText": "<string>",
      "slug": "acme-corp",
      "stripeCustomerId": "<string>",
      "supportAccess": true,
      "supportAccessExpiresAt": "2023-11-07T05:31:56Z",
      "updatedOn": "2023-11-07T05:31:56Z",
      "uuid": "550e8400e29b41d4a716446655440000",
      "archived": true
    },
    "organizationId": "<string>",
    "searchText": "<string>",
    "slug": "<string>",
    "updatedOn": "2023-11-07T05:31:56Z",
    "uuid": "<string>"
  },
  "teamId": "<string>",
  "template": {
    "changeSequence": 123,
    "createdOn": "2023-11-07T05:31:56Z",
    "deleted": true,
    "deprecated": true,
    "description": "<string>",
    "id": "<string>",
    "metadata": {
      "actions": [
        {
          "label": "<string>",
          "properties": {},
          "slug": "<string>",
          "type": "<string>",
          "uuid": "<string>"
        }
      ],
      "agentShortcuts": [
        {
          "id": "<string>",
          "label": "<string>",
          "prompt": "<string>",
          "icon": "<string>"
        }
      ],
      "aiNaming": {
        "enabled": true,
        "prompt": "<string>"
      },
      "chatPrompt": {
        "enabled": true,
        "prompt": "<string>"
      },
      "companion": {
        "agentRuntimeRef": "<string>",
        "moduleRefs": [
          "<string>"
        ],
        "prompt": "<string>"
      },
      "documentFamilyGroups": [
        {
          "automaticallyAdd": true,
          "documentFamilyFilter": "<string>",
          "editable": true,
          "hardMaxPages": 123,
          "knowledgeFeatures": [
            {
              "featureTypeRef": "<string>",
              "required": true
            }
          ],
          "maxHits": 123,
          "maxPages": 123,
          "maxSize": 123,
          "name": "<string>",
          "notes": "<string>",
          "required": true,
          "sort": "<string>",
          "titlePrompt": "<string>",
          "uniqueFilenames": true,
          "uploadOnly": true
        }
      ],
      "executionPolicy": {
        "backoffBaseSeconds": 123,
        "backoffStrategy": "<string>",
        "maxAttempts": 123,
        "onExhausted": "<string>",
        "timeoutSeconds": 123
      },
      "forms": [
        {
          "actions": [
            {
              "label": "<string>",
              "properties": {},
              "slug": "<string>",
              "type": "<string>",
              "uuid": "<string>"
            }
          ],
          "availablePanels": {},
          "dataFormRef": "<string>",
          "properties": {}
        }
      ],
      "options": [
        {
          "aliases": [
            "<string>"
          ],
          "default": "<unknown>",
          "description": "<string>",
          "developerOnly": true,
          "displayProperties": {},
          "falseLabel": "<string>",
          "featureFlag": "<string>",
          "groupOptions": "<array>",
          "hint": "<string>",
          "label": "<string>",
          "listDescription": "<string>",
          "listLabel": "<string>",
          "listType": "<string>",
          "name": "<string>",
          "overviewMarkdown": "<string>",
          "possibleValues": [
            {
              "description": "<string>",
              "label": "<string>",
              "value": "<unknown>"
            }
          ],
          "properties": {},
          "required": true,
          "showIf": "<string>",
          "showOnPopup": true,
          "subType": "<string>",
          "supportArticle": "<string>",
          "tabName": "<string>",
          "type": "<string>"
        }
      ],
      "priority": 123,
      "properties": {},
      "teamSlug": "<string>",
      "workspaceId": "<string>"
    },
    "name": "<string>",
    "organizationId": "<string>",
    "publicAccess": true,
    "slug": "<string>",
    "template": true,
    "updatedOn": "2023-11-07T05:31:56Z",
    "uuid": "<string>",
    "deleteUserEmail": "<string>",
    "deleteUserId": "<string>",
    "deletedDate": "2023-11-07T05:31:56Z",
    "extensionPackRef": "<string>",
    "initialStatusSlug": "<string>",
    "orgSlug": "<string>",
    "organization": {
      "id": "<string>"
    },
    "project": {
      "changeSequence": 123,
      "color": "#4A90D9",
      "createdOn": "2023-11-07T05:31:56Z",
      "dataFlow": {
        "edges": [
          {
            "id": "<string>",
            "properties": {},
            "source": "<string>",
            "target": "<string>"
          }
        ],
        "nodes": [
          {
            "dimensions": {
              "height": 123,
              "width": 123
            },
            "id": "<string>",
            "parentId": "<string>",
            "position": {
              "x": 123,
              "y": 123
            },
            "properties": {},
            "type": "<string>"
          }
        ],
        "viewPort": {
          "x": 123,
          "y": 123,
          "zoom": 123
        }
      },
      "description": "Automated invoice processing pipeline.",
      "documentStatuses": [
        {
          "changeSequence": 123,
          "color": "<string>",
          "createdOn": "2023-11-07T05:31:56Z",
          "icon": "<string>",
          "id": "<string>",
          "projectId": "<string>",
          "slug": "<string>",
          "status": "<string>",
          "statusType": "UNRESOLVED",
          "updatedOn": "2023-11-07T05:31:56Z",
          "uuid": "<string>",
          "project": null
        }
      ],
      "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
      "memory": {
        "changeSequence": 123,
        "orderedDashboards": [
          "<string>"
        ],
        "recentFilters": {},
        "recentQueries": {}
      },
      "name": "Invoice Processing",
      "notes": "<string>",
      "options": {
        "companion": {
          "agentRuntimeRef": "<string>",
          "moduleRefs": [
            "<string>"
          ],
          "prompt": "<string>"
        },
        "dataOptions": [
          {
            "aliases": [
              "<string>"
            ],
            "default": "<unknown>",
            "description": "<string>",
            "developerOnly": true,
            "displayProperties": {},
            "falseLabel": "<string>",
            "featureFlag": "<string>",
            "groupOptions": "<array>",
            "hint": "<string>",
            "label": "<string>",
            "listDescription": "<string>",
            "listLabel": "<string>",
            "listType": "<string>",
            "name": "<string>",
            "overviewMarkdown": "<string>",
            "possibleValues": [
              {
                "description": "<string>",
                "label": "<string>",
                "value": "<unknown>"
              }
            ],
            "properties": {},
            "required": true,
            "showIf": "<string>",
            "showOnPopup": true,
            "subType": "<string>",
            "supportArticle": "<string>",
            "tabName": "<string>",
            "type": "<string>"
          }
        ],
        "dataProperties": {},
        "executionPolicy": {
          "backoffBaseSeconds": 123,
          "backoffStrategy": "<string>",
          "maxAttempts": 123,
          "onExhausted": "<string>",
          "timeoutSeconds": 123
        },
        "groupTaxonTypeFeatures": {},
        "options": [
          {
            "aliases": [
              "<string>"
            ],
            "default": "<unknown>",
            "description": "<string>",
            "developerOnly": true,
            "displayProperties": {},
            "falseLabel": "<string>",
            "featureFlag": "<string>",
            "groupOptions": "<array>",
            "hint": "<string>",
            "label": "<string>",
            "listDescription": "<string>",
            "listLabel": "<string>",
            "listType": "<string>",
            "name": "<string>",
            "overviewMarkdown": "<string>",
            "possibleValues": [
              {
                "description": "<string>",
                "label": "<string>",
                "value": "<unknown>"
              }
            ],
            "properties": {},
            "required": true,
            "showIf": "<string>",
            "showOnPopup": true,
            "subType": "<string>",
            "supportArticle": "<string>",
            "tabName": "<string>",
            "type": "<string>"
          }
        ],
        "properties": {},
        "taskOptions": {
          "showNewTask": true
        },
        "taxonTypeFeatures": {}
      },
      "organization": {
        "authGroupLink": {
          "authGroup": "<string>"
        },
        "changeSequence": 123,
        "createdOn": "2023-11-07T05:31:56Z",
        "defaultToPrivateTemplates": true,
        "description": "Document processing organization for Acme Corp.",
        "enterpriseOrganization": true,
        "features": {},
        "hasImage": true,
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "memory": {
          "orderedDashboards": [
            "<string>"
          ]
        },
        "name": "Acme Corp",
        "organizationStatus": "ACTIVE",
        "properties": {},
        "publicAccess": true,
        "searchText": "<string>",
        "slug": "acme-corp",
        "stripeCustomerId": "<string>",
        "supportAccess": true,
        "supportAccessExpiresAt": "2023-11-07T05:31:56Z",
        "updatedOn": "2023-11-07T05:31:56Z",
        "uuid": "550e8400e29b41d4a716446655440000",
        "archived": true
      },
      "organizationId": "<string>",
      "owner": {
        "active": true,
        "bio": "<string>",
        "businessGroup": "<string>",
        "changeSequence": 123,
        "createdOn": "2023-11-07T05:31:56Z",
        "email": "<string>",
        "firstName": "<string>",
        "groupsJson": "<string>",
        "id": "<string>",
        "image": "<string>",
        "invited": true,
        "isExternallyManaged": true,
        "lastName": "<string>",
        "preferences": {
          "showOnboarding": true,
          "showScrollbars": true,
          "showWelcomeMessage": true
        },
        "rolesJson": "<string>",
        "searchText": "<string>",
        "security": {
          "roles": [
            "<string>"
          ]
        },
        "showDeveloperTools": true,
        "title": "<string>",
        "updatedOn": "2023-11-07T05:31:56Z",
        "userHash": "<string>",
        "userStorage": {
          "favoriteLinks": [
            {
              "link": "<string>"
            }
          ]
        },
        "userType": "<string>",
        "uuid": "<string>"
      },
      "ownerId": "<string>",
      "projectTemplateRef": "<string>",
      "searchText": "<string>",
      "slug": "invoice-processing",
      "status": {
        "changeSequence": 123,
        "color": "<string>",
        "createdOn": "2023-11-07T05:31:56Z",
        "icon": "<string>",
        "id": "<string>",
        "organization": {
          "authGroupLink": {
            "authGroup": "<string>"
          },
          "changeSequence": 123,
          "createdOn": "2023-11-07T05:31:56Z",
          "defaultToPrivateTemplates": true,
          "description": "Document processing organization for Acme Corp.",
          "enterpriseOrganization": true,
          "features": {},
          "hasImage": true,
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "memory": {
            "orderedDashboards": [
              "<string>"
            ]
          },
          "name": "Acme Corp",
          "organizationStatus": "ACTIVE",
          "properties": {},
          "publicAccess": true,
          "searchText": "<string>",
          "slug": "acme-corp",
          "stripeCustomerId": "<string>",
          "supportAccess": true,
          "supportAccessExpiresAt": "2023-11-07T05:31:56Z",
          "updatedOn": "2023-11-07T05:31:56Z",
          "uuid": "550e8400e29b41d4a716446655440000",
          "archived": true
        },
        "organizationId": "<string>",
        "production": true,
        "status": "<string>",
        "updatedOn": "2023-11-07T05:31:56Z",
        "uuid": "<string>"
      },
      "statusId": "<string>",
      "statusType": "ACTIVE",
      "templateArticleId": "<string>",
      "updatedOn": "2023-11-07T05:31:56Z",
      "uuid": "7c9e667974254de944be07fc1f90ae7"
    },
    "projectId": "<string>",
    "ref": "<string>",
    "title": "<string>",
    "type": "<string>",
    "uri": "<string>",
    "yamlSource": "<string>"
  },
  "templateId": "<string>",
  "title": "Review Q4 invoices",
  "updatedOn": "2023-11-07T05:31:56Z",
  "uuid": "<string>",
  "createdByActivityId": "<string>",
  "effectiveCreatedOn": "2023-11-07T05:31:56Z",
  "lockedAt": "2023-11-07T05:31:56Z",
  "lockedById": "<string>",
  "statusSlug": "<string>",
  "taskGroup": {
    "changeSequence": 123,
    "completedTaskCount": 123,
    "createdOn": "2023-11-07T05:31:56Z",
    "id": "<string>",
    "name": "<string>",
    "projectId": "<string>",
    "taskCount": 123,
    "updatedOn": "2023-11-07T05:31:56Z",
    "uuid": "<string>",
    "assignee": {
      "active": true,
      "bio": "<string>",
      "businessGroup": "<string>",
      "changeSequence": 123,
      "createdOn": "2023-11-07T05:31:56Z",
      "email": "<string>",
      "firstName": "<string>",
      "groupsJson": "<string>",
      "id": "<string>",
      "image": "<string>",
      "invited": true,
      "isExternallyManaged": true,
      "lastName": "<string>",
      "preferences": {
        "showOnboarding": true,
        "showScrollbars": true,
        "showWelcomeMessage": true
      },
      "rolesJson": "<string>",
      "searchText": "<string>",
      "security": {
        "roles": [
          "<string>"
        ]
      },
      "showDeveloperTools": true,
      "title": "<string>",
      "updatedOn": "2023-11-07T05:31:56Z",
      "userHash": "<string>",
      "userStorage": {
        "favoriteLinks": [
          {
            "link": "<string>"
          }
        ]
      },
      "userType": "<string>",
      "uuid": "<string>"
    },
    "assigneeId": "<string>",
    "assignmentType": "<string>",
    "deleteUserEmail": "<string>",
    "deleteUserId": "<string>",
    "deleted": true,
    "deletedDate": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "doneStatusSlug": "<string>",
    "effectiveCreatedOn": "2023-11-07T05:31:56Z",
    "history": [
      {
        "changeSequence": 123,
        "createdOn": "2023-11-07T05:31:56Z",
        "id": "<string>",
        "taskGroupId": "<string>",
        "updatedOn": "2023-11-07T05:31:56Z",
        "uuid": "<string>",
        "content": "<string>",
        "detail": null,
        "taskGroup": null,
        "user": null,
        "userId": "<string>"
      }
    ],
    "locked": true,
    "metadata": {},
    "priority": 123,
    "project": {
      "changeSequence": 123,
      "color": "#4A90D9",
      "createdOn": "2023-11-07T05:31:56Z",
      "dataFlow": {
        "edges": [
          {
            "id": "<string>",
            "properties": {},
            "source": "<string>",
            "target": "<string>"
          }
        ],
        "nodes": [
          {
            "dimensions": {
              "height": 123,
              "width": 123
            },
            "id": "<string>",
            "parentId": "<string>",
            "position": {
              "x": 123,
              "y": 123
            },
            "properties": {},
            "type": "<string>"
          }
        ],
        "viewPort": {
          "x": 123,
          "y": 123,
          "zoom": 123
        }
      },
      "description": "Automated invoice processing pipeline.",
      "documentStatuses": [
        {
          "changeSequence": 123,
          "color": "<string>",
          "createdOn": "2023-11-07T05:31:56Z",
          "icon": "<string>",
          "id": "<string>",
          "projectId": "<string>",
          "slug": "<string>",
          "status": "<string>",
          "statusType": "UNRESOLVED",
          "updatedOn": "2023-11-07T05:31:56Z",
          "uuid": "<string>",
          "project": null
        }
      ],
      "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
      "memory": {
        "changeSequence": 123,
        "orderedDashboards": [
          "<string>"
        ],
        "recentFilters": {},
        "recentQueries": {}
      },
      "name": "Invoice Processing",
      "notes": "<string>",
      "options": {
        "companion": {
          "agentRuntimeRef": "<string>",
          "moduleRefs": [
            "<string>"
          ],
          "prompt": "<string>"
        },
        "dataOptions": [
          {
            "aliases": [
              "<string>"
            ],
            "default": "<unknown>",
            "description": "<string>",
            "developerOnly": true,
            "displayProperties": {},
            "falseLabel": "<string>",
            "featureFlag": "<string>",
            "groupOptions": "<array>",
            "hint": "<string>",
            "label": "<string>",
            "listDescription": "<string>",
            "listLabel": "<string>",
            "listType": "<string>",
            "name": "<string>",
            "overviewMarkdown": "<string>",
            "possibleValues": [
              {
                "description": "<string>",
                "label": "<string>",
                "value": "<unknown>"
              }
            ],
            "properties": {},
            "required": true,
            "showIf": "<string>",
            "showOnPopup": true,
            "subType": "<string>",
            "supportArticle": "<string>",
            "tabName": "<string>",
            "type": "<string>"
          }
        ],
        "dataProperties": {},
        "executionPolicy": {
          "backoffBaseSeconds": 123,
          "backoffStrategy": "<string>",
          "maxAttempts": 123,
          "onExhausted": "<string>",
          "timeoutSeconds": 123
        },
        "groupTaxonTypeFeatures": {},
        "options": [
          {
            "aliases": [
              "<string>"
            ],
            "default": "<unknown>",
            "description": "<string>",
            "developerOnly": true,
            "displayProperties": {},
            "falseLabel": "<string>",
            "featureFlag": "<string>",
            "groupOptions": "<array>",
            "hint": "<string>",
            "label": "<string>",
            "listDescription": "<string>",
            "listLabel": "<string>",
            "listType": "<string>",
            "name": "<string>",
            "overviewMarkdown": "<string>",
            "possibleValues": [
              {
                "description": "<string>",
                "label": "<string>",
                "value": "<unknown>"
              }
            ],
            "properties": {},
            "required": true,
            "showIf": "<string>",
            "showOnPopup": true,
            "subType": "<string>",
            "supportArticle": "<string>",
            "tabName": "<string>",
            "type": "<string>"
          }
        ],
        "properties": {},
        "taskOptions": {
          "showNewTask": true
        },
        "taxonTypeFeatures": {}
      },
      "organization": {
        "authGroupLink": {
          "authGroup": "<string>"
        },
        "changeSequence": 123,
        "createdOn": "2023-11-07T05:31:56Z",
        "defaultToPrivateTemplates": true,
        "description": "Document processing organization for Acme Corp.",
        "enterpriseOrganization": true,
        "features": {},
        "hasImage": true,
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "memory": {
          "orderedDashboards": [
            "<string>"
          ]
        },
        "name": "Acme Corp",
        "organizationStatus": "ACTIVE",
        "properties": {},
        "publicAccess": true,
        "searchText": "<string>",
        "slug": "acme-corp",
        "stripeCustomerId": "<string>",
        "supportAccess": true,
        "supportAccessExpiresAt": "2023-11-07T05:31:56Z",
        "updatedOn": "2023-11-07T05:31:56Z",
        "uuid": "550e8400e29b41d4a716446655440000",
        "archived": true
      },
      "organizationId": "<string>",
      "owner": {
        "active": true,
        "bio": "<string>",
        "businessGroup": "<string>",
        "changeSequence": 123,
        "createdOn": "2023-11-07T05:31:56Z",
        "email": "<string>",
        "firstName": "<string>",
        "groupsJson": "<string>",
        "id": "<string>",
        "image": "<string>",
        "invited": true,
        "isExternallyManaged": true,
        "lastName": "<string>",
        "preferences": {
          "showOnboarding": true,
          "showScrollbars": true,
          "showWelcomeMessage": true
        },
        "rolesJson": "<string>",
        "searchText": "<string>",
        "security": {
          "roles": [
            "<string>"
          ]
        },
        "showDeveloperTools": true,
        "title": "<string>",
        "updatedOn": "2023-11-07T05:31:56Z",
        "userHash": "<string>",
        "userStorage": {
          "favoriteLinks": [
            {
              "link": "<string>"
            }
          ]
        },
        "userType": "<string>",
        "uuid": "<string>"
      },
      "ownerId": "<string>",
      "projectTemplateRef": "<string>",
      "searchText": "<string>",
      "slug": "invoice-processing",
      "status": {
        "changeSequence": 123,
        "color": "<string>",
        "createdOn": "2023-11-07T05:31:56Z",
        "icon": "<string>",
        "id": "<string>",
        "organization": {
          "authGroupLink": {
            "authGroup": "<string>"
          },
          "changeSequence": 123,
          "createdOn": "2023-11-07T05:31:56Z",
          "defaultToPrivateTemplates": true,
          "description": "Document processing organization for Acme Corp.",
          "enterpriseOrganization": true,
          "features": {},
          "hasImage": true,
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "memory": {
            "orderedDashboards": [
              "<string>"
            ]
          },
          "name": "Acme Corp",
          "organizationStatus": "ACTIVE",
          "properties": {},
          "publicAccess": true,
          "searchText": "<string>",
          "slug": "acme-corp",
          "stripeCustomerId": "<string>",
          "supportAccess": true,
          "supportAccessExpiresAt": "2023-11-07T05:31:56Z",
          "updatedOn": "2023-11-07T05:31:56Z",
          "uuid": "550e8400e29b41d4a716446655440000",
          "archived": true
        },
        "organizationId": "<string>",
        "production": true,
        "status": "<string>",
        "updatedOn": "2023-11-07T05:31:56Z",
        "uuid": "<string>"
      },
      "statusId": "<string>",
      "statusType": "ACTIVE",
      "templateArticleId": "<string>",
      "updatedOn": "2023-11-07T05:31:56Z",
      "uuid": "7c9e667974254de944be07fc1f90ae7"
    },
    "properties": {},
    "status": {
      "changeSequence": 123,
      "createdOn": "2023-11-07T05:31:56Z",
      "deleted": true,
      "deprecated": true,
      "id": "<string>",
      "name": "<string>",
      "organizationId": "<string>",
      "publicAccess": true,
      "slug": "<string>",
      "template": true,
      "updatedOn": "2023-11-07T05:31:56Z",
      "uuid": "<string>",
      "color": "<string>",
      "deleteUserEmail": "<string>",
      "deleteUserId": "<string>",
      "deletedDate": "2023-11-07T05:31:56Z",
      "extensionPackRef": "<string>",
      "icon": "<string>",
      "label": "<string>",
      "lockDocumentFamily": true,
      "locked": true,
      "metadata": null,
      "orgSlug": "<string>",
      "organization": {
        "id": "<string>"
      },
      "project": {
        "changeSequence": 123,
        "color": "#4A90D9",
        "createdOn": "2023-11-07T05:31:56Z",
        "dataFlow": {
          "edges": [
            {
              "id": "<string>",
              "properties": {},
              "source": "<string>",
              "target": "<string>"
            }
          ],
          "nodes": [
            {
              "dimensions": {
                "height": 123,
                "width": 123
              },
              "id": "<string>",
              "parentId": "<string>",
              "position": {
                "x": 123,
                "y": 123
              },
              "properties": {},
              "type": "<string>"
            }
          ],
          "viewPort": {
            "x": 123,
            "y": 123,
            "zoom": 123
          }
        },
        "description": "Automated invoice processing pipeline.",
        "documentStatuses": [
          {
            "changeSequence": 123,
            "color": "<string>",
            "createdOn": "2023-11-07T05:31:56Z",
            "icon": "<string>",
            "id": "<string>",
            "projectId": "<string>",
            "slug": "<string>",
            "status": "<string>",
            "statusType": "UNRESOLVED",
            "updatedOn": "2023-11-07T05:31:56Z",
            "uuid": "<string>",
            "project": null
          }
        ],
        "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
        "memory": {
          "changeSequence": 123,
          "orderedDashboards": [
            "<string>"
          ],
          "recentFilters": {},
          "recentQueries": {}
        },
        "name": "Invoice Processing",
        "notes": "<string>",
        "options": {
          "companion": {
            "agentRuntimeRef": "<string>",
            "moduleRefs": [
              "<string>"
            ],
            "prompt": "<string>"
          },
          "dataOptions": [
            {
              "aliases": [
                "<string>"
              ],
              "default": "<unknown>",
              "description": "<string>",
              "developerOnly": true,
              "displayProperties": {},
              "falseLabel": "<string>",
              "featureFlag": "<string>",
              "groupOptions": "<array>",
              "hint": "<string>",
              "label": "<string>",
              "listDescription": "<string>",
              "listLabel": "<string>",
              "listType": "<string>",
              "name": "<string>",
              "overviewMarkdown": "<string>",
              "possibleValues": [
                {
                  "description": "<string>",
                  "label": "<string>",
                  "value": "<unknown>"
                }
              ],
              "properties": {},
              "required": true,
              "showIf": "<string>",
              "showOnPopup": true,
              "subType": "<string>",
              "supportArticle": "<string>",
              "tabName": "<string>",
              "type": "<string>"
            }
          ],
          "dataProperties": {},
          "executionPolicy": {
            "backoffBaseSeconds": 123,
            "backoffStrategy": "<string>",
            "maxAttempts": 123,
            "onExhausted": "<string>",
            "timeoutSeconds": 123
          },
          "groupTaxonTypeFeatures": {},
          "options": [
            {
              "aliases": [
                "<string>"
              ],
              "default": "<unknown>",
              "description": "<string>",
              "developerOnly": true,
              "displayProperties": {},
              "falseLabel": "<string>",
              "featureFlag": "<string>",
              "groupOptions": "<array>",
              "hint": "<string>",
              "label": "<string>",
              "listDescription": "<string>",
              "listLabel": "<string>",
              "listType": "<string>",
              "name": "<string>",
              "overviewMarkdown": "<string>",
              "possibleValues": [
                {
                  "description": "<string>",
                  "label": "<string>",
                  "value": "<unknown>"
                }
              ],
              "properties": {},
              "required": true,
              "showIf": "<string>",
              "showOnPopup": true,
              "subType": "<string>",
              "supportArticle": "<string>",
              "tabName": "<string>",
              "type": "<string>"
            }
          ],
          "properties": {},
          "taskOptions": {
            "showNewTask": true
          },
          "taxonTypeFeatures": {}
        },
        "organization": {
          "authGroupLink": {
            "authGroup": "<string>"
          },
          "changeSequence": 123,
          "createdOn": "2023-11-07T05:31:56Z",
          "defaultToPrivateTemplates": true,
          "description": "Document processing organization for Acme Corp.",
          "enterpriseOrganization": true,
          "features": {},
          "hasImage": true,
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "memory": {
            "orderedDashboards": [
              "<string>"
            ]
          },
          "name": "Acme Corp",
          "organizationStatus": "ACTIVE",
          "properties": {},
          "publicAccess": true,
          "searchText": "<string>",
          "slug": "acme-corp",
          "stripeCustomerId": "<string>",
          "supportAccess": true,
          "supportAccessExpiresAt": "2023-11-07T05:31:56Z",
          "updatedOn": "2023-11-07T05:31:56Z",
          "uuid": "550e8400e29b41d4a716446655440000",
          "archived": true
        },
        "organizationId": "<string>",
        "owner": {
          "active": true,
          "bio": "<string>",
          "businessGroup": "<string>",
          "changeSequence": 123,
          "createdOn": "2023-11-07T05:31:56Z",
          "email": "<string>",
          "firstName": "<string>",
          "groupsJson": "<string>",
          "id": "<string>",
          "image": "<string>",
          "invited": true,
          "isExternallyManaged": true,
          "lastName": "<string>",
          "preferences": {
            "showOnboarding": true,
            "showScrollbars": true,
            "showWelcomeMessage": true
          },
          "rolesJson": "<string>",
          "searchText": "<string>",
          "security": {
            "roles": [
              "<string>"
            ]
          },
          "showDeveloperTools": true,
          "title": "<string>",
          "updatedOn": "2023-11-07T05:31:56Z",
          "userHash": "<string>",
          "userStorage": {
            "favoriteLinks": [
              {
                "link": "<string>"
              }
            ]
          },
          "userType": "<string>",
          "uuid": "<string>"
        },
        "ownerId": "<string>",
        "projectTemplateRef": "<string>",
        "searchText": "<string>",
        "slug": "invoice-processing",
        "status": {
          "changeSequence": 123,
          "color": "<string>",
          "createdOn": "2023-11-07T05:31:56Z",
          "icon": "<string>",
          "id": "<string>",
          "organization": {
            "authGroupLink": {
              "authGroup": "<string>"
            },
            "changeSequence": 123,
            "createdOn": "2023-11-07T05:31:56Z",
            "defaultToPrivateTemplates": true,
            "description": "Document processing organization for Acme Corp.",
            "enterpriseOrganization": true,
            "features": {},
            "hasImage": true,
            "id": "550e8400-e29b-41d4-a716-446655440000",
            "memory": {
              "orderedDashboards": [
                "<string>"
              ]
            },
            "name": "Acme Corp",
            "organizationStatus": "ACTIVE",
            "properties": {},
            "publicAccess": true,
            "searchText": "<string>",
            "slug": "acme-corp",
            "stripeCustomerId": "<string>",
            "supportAccess": true,
            "supportAccessExpiresAt": "2023-11-07T05:31:56Z",
            "updatedOn": "2023-11-07T05:31:56Z",
            "uuid": "550e8400e29b41d4a716446655440000",
            "archived": true
          },
          "organizationId": "<string>",
          "production": true,
          "status": "<string>",
          "updatedOn": "2023-11-07T05:31:56Z",
          "uuid": "<string>"
        },
        "statusId": "<string>",
        "statusType": "ACTIVE",
        "templateArticleId": "<string>",
        "updatedOn": "2023-11-07T05:31:56Z",
        "uuid": "7c9e667974254de944be07fc1f90ae7"
      },
      "projectId": "<string>",
      "ref": "<string>",
      "sequence": 123,
      "statusType": "OPEN",
      "type": "<string>",
      "uri": "<string>",
      "yamlSource": "<string>"
    },
    "statusSlug": "<string>",
    "team": {
      "changeSequence": 123,
      "createdOn": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "id": "<string>",
      "name": "<string>",
      "organization": {
        "authGroupLink": {
          "authGroup": "<string>"
        },
        "changeSequence": 123,
        "createdOn": "2023-11-07T05:31:56Z",
        "defaultToPrivateTemplates": true,
        "description": "Document processing organization for Acme Corp.",
        "enterpriseOrganization": true,
        "features": {},
        "hasImage": true,
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "memory": {
          "orderedDashboards": [
            "<string>"
          ]
        },
        "name": "Acme Corp",
        "organizationStatus": "ACTIVE",
        "properties": {},
        "publicAccess": true,
        "searchText": "<string>",
        "slug": "acme-corp",
        "stripeCustomerId": "<string>",
        "supportAccess": true,
        "supportAccessExpiresAt": "2023-11-07T05:31:56Z",
        "updatedOn": "2023-11-07T05:31:56Z",
        "uuid": "550e8400e29b41d4a716446655440000",
        "archived": true
      },
      "organizationId": "<string>",
      "searchText": "<string>",
      "slug": "<string>",
      "updatedOn": "2023-11-07T05:31:56Z",
      "uuid": "<string>"
    },
    "teamId": "<string>"
  },
  "taskGroupId": "<string>"
}

Completing a task with a discarded save

When the requested statusSlug differs from the task’s current status and resolves to a status of type DONE, the platform first checks the task’s documents. If the most recent saved changes for one of them were discarded server-side and never redone, the transition is refused with 409 Conflict and nothing is written.

The message names the affected documents by path (or by ID when a document has no path):

{
  "code": "CONFLICT",
  "message": "Cannot complete this task: the most recent saved changes for invoices/2026-08/inv-1042.pdf were not applied to the stored document (the save failed server-side). Reopen the document, redo the changes, and save again before completing."
}

To clear the block, reopen each document the message names, redo the changes, and save again. A successful re-save — or any full-document save — releases it and the task completes normally.

Only the latest save per document counts, so a failure that has already been redone and saved does not block completion. Transitions to statuses of any other type are unaffected.

This endpoint also returns 409 Conflict for a stale changeSequence; the two cases share the CONFLICT code and are distinguished by the message.

Authorizations

x-api-keybearerAuth

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

statusSlug · string

Slug of the new task status.

Response

200

application/json

Updated task

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

assignee · object | null · required

A platform user represents a user account in the Kodexa platform.

Show child attributes

assigneeId · string | null · required

ID of the user assigned to this task.

changeSequence · integer<int32> · required

Optimistic locking version number.

completedDate · string<date-time> | null · required

Date when the task was completed.

createdOn · string<date-time> · required

Timestamp when the task was created.

deleteUserEmail · string · required

Email of the user who deleted the task.

deleteUserId · string · required

ID of the user who deleted the task.

deleted · boolean · required

Whether the task has been soft-deleted.

deletedDate · string<date-time> | null · required

Timestamp when the task was soft-deleted.

description · string · required

Detailed description of the task.

Example:

"Review and validate all Q4 2025 invoices."

dueDate · string<date-time> | null · required

Due date for the task.

id · string · required

Unique identifier (UUID) for the task.

Example:

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

locked · boolean · required

Whether the task is locked for editing.

metadata · object · required

Task metadata including custom fields.

Show child attributes

parentTask · unknown · required

parentTaskId · string | null · required

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

plan · object | null · required

Show child attributes

priority · integer<int32> | null · required

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

Example:

1

project · object | null · required

A project groups related document stores, assistants, tasks, and processing pipelines within an organization.

Show child attributes

projectId · string | null · required

ID of the project this task belongs to.

properties · object | null · required

Task properties for UI state and configuration.

Show child attributes

searchText · string · required

Full-text searchable representation of the task.

signal · object · required

Signal from human reviewer for plan-aware task completion.

Show child attributes

taskActivities · object[] | null · required

Show child attributes

team · object | null · required

A team groups users together for collaborative access control within projects.

Show child attributes

teamId · string | null · required

template · object | null · required

A task template defines a reusable task configuration with default values.

Show child attributes

templateId · string | null · required

ID of the task template used.

title · string · required

Title of the task.

Example:

"Review Q4 invoices"

updatedOn · string<date-time> · required

Timestamp when the task was last updated.

uuid · string · required

Secondary UUID identifier.

createdByActivityId · string | null

effectiveCreatedOn · string<date-time> | null

Document-arrival timestamp used for FIFO take-next ordering: the earliest created_on across the task's non-deleted document families, falling back to the task's own created_on when it has none. Maintained by the database; read-only.

lockedAt · string<date-time> | null

lockedById · string | null

statusSlug · string | null

taskGroup · object | null

Show child attributes

taskGroupId · string | null