Update Runbook Task
update_runbook_taskModify an existing runbook task's details, dependencies, schedule, assignees, or type to keep execution plans current.
Instructions
Update an existing task in a runbook (including dependencies, description, stream, duration, etc.).
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"runbook_id": "<runbook_id>",
"task_id": "<task_id>"
},
"name": "update_runbook_task"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | The new name for the task. | |
| level | No | The task's level (default level_3). | |
| message | No | For an Email/SMS/Call comms task, the message body. For an agentic task, the initial prompt the AI agent receives when the task starts: when the user asks to set, change or rewrite an agentic task's prompt or instructions, update this field. | |
| task_id | Yes | The ID of the task to update. | |
| duration | No | Planned duration in seconds. | |
| assignees | No | List of assignees to add to the task. Only users and teams that are already participants on the runbook can be assigned; non-participants are silently ignored by the API. By default these are added without removing existing assignees; set delete_excluded_assignees=True to replace the full list instead. | |
| end_fixed | No | ISO 8601 timestamp fixing the task's end time. | |
| stream_id | No | The ID of the stream to assign the task to (can be a substream). | |
| auto_start | No | Whether the task should start automatically once its predecessors complete. | |
| recipients | No | List of recipients for a comms task (Email/SMS/Call). | |
| runbook_id | Yes | The ID of the runbook containing the task. | |
| task_links | No | Replaces the task's links to other resources. Use ``link_type="runbook"`` to link a task to a template runbook — the target must be a template runbook and must have ≥1 task. Use ``link_type="snippet"`` to attach one or more snippets. Pass an empty list to clear all links. | |
| auto_finish | No | Whether the task should complete automatically once started. | |
| description | No | The new description for the task. | |
| start_fixed | No | ISO 8601 timestamp fixing the task's start time. | |
| predecessors | No | A list of task IDs that are predecessors to this task. | |
| task_type_id | No | Task type ID from ``list_task_types`` (integration-backed and agentic types included) to change what kind of task this is. | |
| custom_field_values | No | Custom field values to update. Identify each field by custom_field_id, using the id returned by list_custom_fields with scope="task": {"custom_field_id": "123", "value": ...}. A field's internal ``name`` can be used instead of the id, but its ``display_name`` cannot. For select_menu and radiobox fields, pass the option name; for checkboxes, pass a list of option names. Pass "" to clear a field. If the API reports 'Custom field "" was not found' for a valid id, the field is most likely not available for the task's type. Values in the response are listed by ``name``, with custom_field_id set to null. | |
| delete_excluded_assignees | No | When False (default), adds the given assignees without removing existing ones. When True, replaces the full assignee list with only the assignees provided. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| data | Yes | ||
| included | No |