Update a task
PUT /api/v3/organizations/{organisation}/ai/tasks/{taskId}
Updates an existing task. All fields are optional - only provided fields will be updated. * * Status Transitions: * - Changing from pending to in_progress automatically sets startedAt timestamp * - Changing to completed, failed, or cancelled automatically sets completedAt timestamp * - Completed tasks get a 30-day TTL for automatic cleanup * * Progress Updates: * - Update progress (0.0 to 1.0) to track completion percentage * - Update progressMessage for human-readable status updates * - Set result object when task completes successfully * - Set error string when task fails
Authorizations
Parameters
Path Parameters
The organisation ID
The task UUID
Example
550e8400-e29b-41d4-a716-446655440000Request Body required
object
Updated task titleUpdated description with more detailsMove task to different list or remove from list (set null)
world-2Task status (triggers automatic timestamp updates)
in_progressReassign task to different agent
agent-specialistUpdate task dependencies
[ "550e8400-e29b-41d4-a716-446655440000"]Update task metadata (replaces entire metadata object)
object
{ "priority": "urgent"}Progress from 0.0 to 1.0
0.75Human-readable progress message
Processing document 3 of 4...Task result data (set when completing task)
object
{ "summary": "Document processed successfully", "wordCount": 1500}Error message (set when task fails)
Failed to connect to external APIUpdate retry count
1Update maximum retry attempts
5Responses
200
Task updated successfully
object
400
Invalid request
404
Task not found
500
Failed to update task