Update a task template

Updates an existing task template by modifying its configuration, properties, and metadata while preserving its unique identifier and existing task instances. Task templates are reusable blueprints that define standardized task structures including title, description, priority levels, estimated duration, custom properties, default assignees, and field configurations used for creating consistent tasks across programs and workflows. This endpoint allows you to refine template definitions, update default values, modify custom property configurations, change priority settings, adjust estimated time allocations, and update descriptive content without affecting tasks already created from the template.

Key Features:

  • Updates template configuration including title, description, priority defaults, and estimated duration for improved template accuracy
  • Modifies custom property definitions and default values to align with evolving business requirements
  • Changes default assignee, follower, and notification settings to reflect current team structures
  • Updates template metadata such as visibility settings, categorization tags, and organizational labels
  • Preserves template ID ensuring consistency in template references across systems and workflows
  • Does not affect existing task instances created from the template - they retain their original configuration
  • Supports partial updates allowing you to modify specific fields without providing complete template definition
  • Validates updates against workspace constraints and custom property definitions to ensure data integrity

Authorization Logic:

  • User must have a valid JWT token with management scopes
  • User must have management permissions for the specified space (seismic.programs.manage)
  • Returns 403 if user lacks required management permissions for the space
  • Returns 401 if authentication fails due to missing, invalid, or expired token
  • Returns 404 if template or space does not exist or user has no access

Usage Examples:

Example 1: Update template title and description for clarity

Call PUT /v2/spaces/w5PmrE9p0kicqqRSVJ3VBQ/tasks/template/zK95yNV8rok6PXteVFyKTi with body {"title": "Product Launch - Marketing Campaign Setup", "description": "Template for initializing marketing campaigns during product launches including social media, email, and content creation tasks"} to rename and clarify template purpose. New tasks created from this template will use the updated title/description, but existing tasks remain unchanged.

Example 2: Change default priority and estimated duration

Call PUT /v2/spaces/w5PmrE9p0kicqqRSVJ3VBQ/tasks/template/zK95yNV8rok6PXteVFyKTi with body {"priority": "high", "estimatedDuration": "PT8H"} to update default priority to high and estimated duration to 8 hours. Future tasks created from this template will inherit these new defaults.

Example 3: Update custom property definitions

Call PUT /v2/spaces/w5PmrE9p0kicqqRSVJ3VBQ/tasks/template/zK95yNV8rok6PXteVFyKTi with body {"customProperties": [{"id": "FTFcbnlcfkKZCmnew-bGxw", "value": "Marketing"}]} to set default department custom property value. This standardizes categorization for tasks created from the template.

Path Params
string
required
length between 7 and 22

The unique identifier of the space containing the target entity. This determines the scope of entity queries and ensures proper access control. The space must be accessible to the authenticated user with appropriate permissions. It can be the unique identifier (GUID) of the space or the word "default" to indicate the default programs space. Common values include "default" and "rkr83lapKkyCJuLLWqLqzB".

string
required

task template id

Body Params

The update request containing the template properties to modify. Only provided fields will be updated.

string

Updated human-readable title or name for the task. Required field that should be concise yet descriptive. Changing this updates what users see in task lists and reports. Ensure the new title clearly identifies the task's purpose.

string | null

Updated detailed textual description providing comprehensive task information, instructions, or context. Can be set to null to remove existing description. Use to refine task requirements or add new information as the task evolves.

int32 | null

Updated workflow step identifier to transition the task to a new status within its status schema. Must be a valid step ID from the task's statusSchemaId. Set to null to clear status. Use to move tasks through workflow stages like 'In Progress' to 'Complete'.

string | null

Updated unique identifier of the user to assign this task to, or null to unassign. Must be a valid user ID with access to the space. Changing assignee triggers notifications to the new assignee and updates assignerId to track who made the change.

date-time | null

Updated target start date/time in ISO 8601 format when work should begin, or null to clear. Use when schedules change or to defer task start. Affects timeline calculations and visualization in program planning views.

date-time | null

Updated target completion date/time (due date) in ISO 8601 format, or null to remove deadline. Use when deadlines shift or to set/remove time constraints. May trigger recalculation of related task schedules if dependencies exist.

int32 | null

Updated estimated duration in days for task completion, or null to clear. Use for revised work estimates. Can interact with plannedStartDate/plannedEndDate for automatic date calculations depending on system configuration.

string | null

Updated unique identifier of the program to associate this task with, or null to remove program association. Use to move tasks between programs or link standalone tasks to programs for coordinated portfolio management.

string | null
enum

Updated priority level classification ('low', 'medium', 'high', 'critical') to reflect changing task importance, or null to remove priority. Use when business needs shift to re-prioritize work and help teams focus on urgent items.

Allowed:
customProperties
array of objects | null

Updated array of custom property value objects to replace existing custom property data, or null to clear all. Each object contains custom property ID and values array. Use to update organization-specific metadata like budget codes, departments, or custom categories.

customProperties
string | null

Updated unique identifier of the parent task to change task hierarchy, or null to make this a top-level task. Use to reorganize task breakdowns by moving subtasks to different parents or promoting subtasks to standalone tasks.

Responses

Language
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json