GuidesAPI DocsChangelogMy AppsSeismic Exchange
API Docs

Update a program template

put
https://api.seismic.com/programs/v2/spaces//programs/template/

Updates an existing program template with new data. Performs a complete replacement of the template
structure, settings, and configuration. The updated template will be used for any future program
creations but does not affect programs already created from this template.

Key Features:

  • Updates complete template structure and settings
  • Modifies title, description, and manager assignments
  • Updates planned dates and duration
  • Changes custom properties and their values
  • Updates recurrence settings for automated program generation
  • Does not affect existing programs created from this template
  • Associations cannot be modified during template updates

Authorization Logic:

  1. User must have a valid JWT token with management scopes
  2. User must have program update permissions
  3. User must have permission to update the specific template
  4. Manager ID must be valid if specified

Usage Example:

Update a program template to reflect changes in standard workflows, adjust default settings
for future program creations, or modify recurrence patterns for automated program generation.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
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

The unique identifier of the program template to update. Must be a valid template ID within the specified space.

Body Params

The complete program template data to update. All fields provided will replace existing values.

string

Human-readable display title for the program template shown in template galleries, selection interfaces, and program creation workflows. Should be concise yet descriptive of the template's purpose and use case, typically 5-100 characters. Use clear, professional naming that helps users quickly identify the appropriate template for their needs. Examples include 'Quarterly Business Review', 'Product Launch Campaign', 'New Hire Onboarding'. This title becomes the default program title when users create programs from this template, though they can customize it during creation. Required field that cannot be empty or whitespace-only.

string

Detailed textual description explaining the template's purpose, intended use cases, recommended scenarios, and any guidance for users selecting or applying this template. Supports plain text or markdown formatting depending on implementation. Typical length ranges from 50-500 characters providing meaningful context beyond the title. Use this to document what the template is designed for, which teams or situations it suits best, and any important considerations. For example, describe target audience, typical duration, key phases, or success criteria. This description helps users make informed template selection decisions and appears in template previews, galleries, and selection interfaces. Can be updated to reflect template improvements or changing organizational needs.

date-time | null

Default or recommended start date for programs created from this template, represented in ISO 8601 format (e.g., '2025-01-15T00:00:00Z'). Optional field (nullable) that provides a suggested starting point for template-based programs, useful for templates tied to fiscal calendars, seasonal campaigns, or recurring organizational events. When users create programs from this template, this date can serve as the default value or be adjusted based on their specific timing needs. Supports full date-time precision including timezone. Use this to establish consistent scheduling patterns for template-based programs, such as quarterly review cycles or annual planning initiatives. Can be null if the template is not tied to specific dates.

date-time | null

Default or recommended end date for programs created from this template, represented in ISO 8601 format (e.g., '2025-03-31T23:59:59Z'). Optional field (nullable) that establishes the expected completion timeframe for template-based programs. Should be chronologically after plannedStartDate when both are provided. When combined with plannedStartDate, enables automatic calculation of plannedDuration for programs created from this template. Useful for templates with standard execution timeframes like 30-day onboarding programs, 90-day campaigns, or annual planning cycles. Users can adjust this date when creating programs to accommodate specific organizational needs or timeline variations. Supports full date-time precision including timezone. Can be null if the template has flexible or open-ended timing.

int32

Default expected duration for programs created from this template, expressed as a positive integer representing the number of calendar days from start to completion. This field provides a standard timeframe guideline for template-based programs, helping users understand the typical execution length and plan resources accordingly. Common values range from 7 days for quick initiatives to 365+ days for annual programs, with typical templates using 30, 60, or 90-day durations. When programs are created from this template, this duration serves as the default value but can be adjusted based on specific program requirements. If both plannedStartDate and plannedEndDate are provided, duration can be calculated automatically. Use this to establish consistent program scoping and timeline expectations across similar initiatives, enabling better resource planning and workload management. Must be a positive integer value.

boolean

Boolean flag indicating whether this program template is currently active and available for use in template galleries, program creation workflows, and selection interfaces. When true, the template is visible to users with appropriate permissions and can be selected for creating new programs. When false, the template is hidden from standard template listings and cannot be used for new program creation, though existing programs created from this template remain unaffected. Use this to control template lifecycle and availability without permanently deleting templates, enabling seasonal templates, deprecated workflows, or templates undergoing revision. Setting to false provides a soft-disable mechanism for templates that may be reactivated later, preserving template configuration and historical context while preventing new usage.

customProperties
array of objects | null

Array of custom property definitions and default values to pre-populate on programs created from this template. Each CustomPropertyValues object specifies a custom property and its initial value, enabling templates to establish consistent metadata, categorization, and tracking fields across similar programs. Use this to configure default budget allocations, organizational units, campaign types, compliance requirements, or any organization-specific attributes. When users create programs from this template, these custom properties are automatically applied but can be modified as needed. Empty array or null indicates no custom property defaults are configured. Supports both simple values and complex property types depending on custom property definitions in the workspace.

customProperties
string | null

Unique identifier (GUID format, e.g., 'c94f35e8-6d4a-4b2e-9f1a-7e8d9c2b1a3f') of the user to automatically assign as program manager for programs created from this template. This establishes default ownership and accountability for template-based programs, ensuring consistent management assignments across similar initiatives. When users create programs from this template, this manager is automatically assigned but can be changed during or after program creation. The specified user must exist in the system and have appropriate permissions to manage programs. Use this to standardize program ownership patterns, such as assigning templates to specific team leads, department managers, or role-based assignments. Null indicates no default manager is assigned, requiring manual assignment during program creation.

recurrence

Recurrence configuration defining automated scheduling and repetition patterns for programs created from this template. When configured, enables automatic creation of recurring program instances based on specified frequency (weekly, monthly, yearly, or specific dates), cadence intervals, and date boundaries. Use this for templates representing recurring organizational activities like quarterly business reviews, monthly team meetings, weekly status reports, or annual planning cycles. The Recurrence object specifies all scheduling parameters including start/end dates, frequency patterns, content automation settings, and task assignment rules. Null indicates the template is for one-time programs without automated recurrence. When recurrence is configured, programs created from this template inherit these scheduling patterns and can generate recurring instances automatically.

analyticSetting

Analytics and tracking configuration to pre-populate on programs created from this template, including outcome KPIs, metric objectives, program lifecycle phases, archival settings, audience targets, topics, trackers, and program type classification. Use this to establish consistent success measurement frameworks and tracking patterns across similar programs. For example, configure sales enablement templates to track WinRate and InfluencedRevenue KPIs, or training program templates to measure completion rates and engagement metrics. The ProgramAnalyticSettingInput object enables default phase definitions, target audience specifications, and analytical tracking that programs inherit from the template. Null indicates no default analytics configuration, allowing programs to define their own measurement framework independently.

pageTemplate

Page structure and content organization template defining the default page layout, sections, content types, and lessons for programs created from this template. The PageTemplate object specifies how program content should be organized including page templates, content model arrays, lesson structures, and display configurations. Use this to establish consistent content organization patterns across similar programs, such as standard training program structures with introduction pages, learning modules, and assessment pages, or sales campaign layouts with planning phases, execution guides, and reporting sections. When users create programs from this template, the page structure is automatically inherited but can be customized. Null indicates programs created from this template start with no predefined page structure, allowing flexible content organization.

Responses

Updated 6 days ago

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

Updated 6 days ago