GuidesAPI DocsChangelogMy AppsSeismic Exchange
API Docs

Apply a program template

post
https://api.seismic.com/programs/v2/spaces//programs/template//apply

Creates a new program from an existing program template with optional overrides for customization.
The template structure, phases, tasks, and settings are copied to the new program, which can then
be customized with specific managers, dates, and other parameters. The operation is performed
asynchronously and returns operation IDs for tracking progress.

Key Features:

  • Creates programs from reusable templates
  • Copies template structure including phases and analytics
  • Allows overriding title, description, and manager
  • Customizes planned dates and duration
  • Optionally removes assignees from copied tasks
  • Includes or excludes content and analytics settings
  • Supports task copying with customization
  • Returns async operation IDs for tracking creation progress

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 view the source template
  4. User must have permission to create programs in the space

Usage Example:

Apply a quarterly business review template to create Q4 2025 review program with customized
manager and dates, or use a product launch template to quickly set up a new product campaign
with specific team assignments.

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 apply. Must be a valid template ID within the specified space.

Body Params

Request body containing optional configuration overrides to customize the new program created from the specified template. Overrides can change the program title, description, manager assignment, planned start and end dates, custom property values, and other program-specific attributes. Provided overrides take precedence; omitted or null fields inherit from the template definition. Enables flexible program creation from a template while allowing per-instance customization. Must conform to ApplyProgramTemplateReq with valid property types and formats.

string | null

Human-readable title for the program created from the template. Overrides the template's default title when provided. Displayed prominently in program listings, cards, and headers throughout the UI. Should be concise yet descriptive, typically 5-100 characters, conveying the specific program instance's purpose (e.g., 'Q2 2025 Product Launch' or 'EMEA Sales Enablement - March'). Users see this title when browsing programs, in search results, and in navigation breadcrumbs. If null or omitted and overrideMode is false, the program inherits the template's title. If null and overrideMode is true, the title is cleared. Required to distinguish this program instance from other programs created from the same template.

string | null

Detailed textual description for the program created from the template. Overrides the template's default description when provided. Supports plain text or markdown formatting depending on workspace configuration. Typically 50-2000 characters, documenting the program's specific objectives, scope, deliverables, target audience, timeline considerations, and success criteria for this particular instance. Appears in program detail views, overview pages, and tooltip previews. Should provide enough context for stakeholders to understand the program's purpose without opening individual tasks. If null or omitted and overrideMode is false, inherits the template description. If null and overrideMode is true, clears the description. Helps differentiate this specific program execution from the generic template purpose.

date-time | null

Planned start date for the program created from the template, overriding the template's default start date. Must be in ISO 8601 format with full date-time precision and timezone (e.g., '2025-04-01T09:00:00Z' or '2025-04-01T00:00:00-05:00'). Represents when program execution is scheduled to begin, used for timeline visualization, Gantt charts, calendar integrations, and automated notifications. Should typically be chronologically before plannedEndDate when both are specified. If null or omitted and overrideMode is false, inherits the template's plannedStartDate. If null and overrideMode is true, clears the start date, creating an open-ended or flexible-start program. Critical for programs aligned with fiscal periods, campaign launches, or event-driven initiatives where specific timing is essential.

date-time | null

Planned end date for the program created from the template, overriding the template's default end date. Must be in ISO 8601 format with full date-time precision and timezone (e.g., '2025-06-30T17:00:00Z' or '2025-06-30T23:59:59-05:00'). Represents the target completion date for program execution, used for deadline tracking, resource planning, timeline visualization, and automated deadline reminders. Should typically be chronologically after plannedStartDate when both are specified. The system may automatically calculate plannedDuration if both start and end dates are provided. If null or omitted and overrideMode is false, inherits the template's plannedEndDate. If null and overrideMode is true, clears the end date, creating a flexible or ongoing program without a fixed deadline. Essential for time-bound initiatives like quarterly business reviews, seasonal campaigns, or compliance programs with regulatory deadlines.

int32 | null

Planned duration in calendar days for the program created from the template, overriding the template's default duration. Must be a positive integer representing the number of days from program start to completion. Common values range from 7 days for sprint-style programs to 365+ days for annual strategic initiatives, with typical durations of 30, 60, or 90 days. The system may use this value to automatically calculate plannedEndDate if a plannedStartDate is provided. Conversely, if both start and end dates are specified, the system may calculate and display duration automatically. Serves as a planning guideline for resource allocation, workload estimation, and timeline expectations. If null or omitted and overrideMode is false, inherits the template's plannedDuration. If null and overrideMode is true, clears the duration, requiring users to manually set timeline expectations. Essential for standardizing program scoping and establishing consistent execution timeframes across similar program types.

string | null

Unique identifier for the user to assign as program manager, overriding the template's default manager assignment. Must be in GUID format (e.g., 'c94f35e8-6d4a-4b2e-9f1a-7e8d9c2b1a3f') or stable user ID format depending on your authentication system. The program manager has primary ownership and accountability for program execution, progress tracking, and deliverable completion. Automatically grants management-level permissions including editing program details, assigning tasks, managing team members, and approving milestones. The specified user must exist in the workspace and have appropriate permissions to manage programs in the target space. If null or omitted and overrideMode is false, inherits the template's managerId assignment. If null and overrideMode is true, clears the manager assignment, creating a program without a designated owner that requires manual assignment post-creation. Critical for establishing clear accountability and ensuring proper access control for program administration.

boolean | null

Controls whether task assignees from the template should be removed when creating the program. When true, all task assignments inherited from the template are cleared, creating unassigned tasks that require manual assignment after program creation. When false (default behavior), tasks inherit their assignee configurations from the template, pre-populating assignments for faster program launch. Useful when applying a template in a different organizational context where the original assignees are not appropriate (e.g., cross-regional program deployment, different team structure, or when using role-based templates that need user-specific assignment). If true, consider whether includeAllContents should also be adjusted to ensure content references remain valid. If null, defaults to false, preserving template assignee configurations. Commonly used in conjunction with overrideMode to control how much customization is needed post-creation.

boolean | null

Determines whether all content items associated with the template should be linked to the new program. When true, the system copies all content associations from the template to the newly created program, establishing immediate links to documents, presentations, training materials, and other Seismic content items. When false (default behavior), content associations are not copied, allowing users to manually curate content references specific to this program instance. Particularly useful for training programs, sales enablement campaigns, or onboarding workflows where standardized content libraries are essential. Consider workspace content permissions and visibility when including content, as all program participants may gain access to associated items. If null, defaults to false, requiring explicit content association post-creation. Content references use Seismic's content management system and may include versioning, approval workflows, and access control policies inherited from the content items themselves.

boolean | null

Controls whether the program should inherit the analytics configuration from the template. When true, the new program copies all analytics settings including KPI definitions, metric objectives, measurement phases, target audiences, program type classification, and tracking parameters from the template, establishing immediate success measurement frameworks. When false (default behavior), analytics settings are not inherited, allowing users to define custom measurement criteria specific to this program instance. Essential for maintaining consistent tracking and reporting across similar programs (e.g., all quarterly business reviews measure the same KPIs, all sales training programs track completion rates and engagement metrics). The analytics configuration includes ProgramAnalyticSettingInput properties such as outcome metrics, lifecycle phases, archival settings, and audience targeting. If null, defaults to false, requiring manual analytics configuration post-creation. Commonly set to true when organizational standards mandate specific measurement frameworks for certain program types.

pageTemplate

Custom page structure and content organization configuration to apply when creating the program, overriding the template's default page layout. When provided, this PageTemplate object completely replaces the template's page structure, allowing full customization of page layouts, sections, content types, lessons, and display configurations specific to this program instance. Use this when the program requires different content organization than the template default—for example, adding region-specific sections, removing irrelevant phases, or restructuring lesson flows for different audience levels. The PageTemplate object defines how program content is organized including page templates, content model arrays, lesson structures, and display settings. If null or omitted and overrideMode is false, inherits the template's page structure. If null and overrideMode is true, clears the page template, creating a program with no predefined content structure that requires manual page organization post-creation. Critical for programs that need customized learning paths, workflow phases, or content delivery patterns while still leveraging the template's task structure and timeline.

boolean | null

Controls how null or missing request fields are handled when applying the template. When true, any field not explicitly provided in the request (or provided as null) is cleared in the resulting program, rather than inheriting the template's default value. This creates a "replace" semantic where only explicitly specified fields are populated. When false (default behavior), any field not provided or provided as null inherits the corresponding value from the template, creating an "overlay" semantic where the template provides defaults and the request overrides specific values. For example, if overrideMode is true and managerId is null, the program is created without a manager assignment. If overrideMode is false and managerId is null, the program inherits the template's manager. Essential for distinguishing between "I want to explicitly clear this field" versus "I want to use the template default." Commonly set to true when creating highly customized programs that should not inherit most template values, and false when creating standard instances that need only minor adjustments to template defaults. Affects all nullable fields including title, description, dates, duration, managerId, and pageTemplate.

Responses

Updated about 23 hours ago

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