GuidesAPI DocsChangelogMy AppsSeismic Exchange
API Docs

Create a program template from an existing program

post
https://api.seismic.com/programs/v2/spaces//programs//makeTemplate

Converts an existing program into a reusable template that can be used to create new programs with
predefined structure, settings, and configuration. The template creation is performed asynchronously
and returns operation IDs for tracking the conversion progress.

Key Features:

  • Converts an existing program into a reusable template
  • Preserves program structure, phases, and analytics settings
  • Allows overriding title and description for the template
  • Optionally includes tasks, custom properties, and followers
  • Returns async operation IDs for tracking template creation progress
  • Template can be used to create multiple programs with consistent structure
  • Processes conversion asynchronously for better performance

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 program
  4. User must have permission to create templates in the space

Usage Example:

Convert a successful campaign program into a template that can be reused for future similar campaigns,
or create standardized program templates for common workflows like product launches or training initiatives.

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 to convert into a template. Must be a valid program ID within the specified space.

Body Params

Request body containing optional configuration overrides to apply when converting the program to a template. Can specify alternative template title, description, recurrence settings, and other template-specific metadata that differ from the source program's values. When provided, these overrides replace corresponding values from the source program. When omitted or null properties are specified, the template inherits those values directly from the source program. Enables customization of template metadata while preserving program structure and relationships. Must conform to MakeTemplateFromProgramReq schema with valid override properties.

string

Human-readable name for the program template being created from the source program. This title will identify the template in template galleries, selection dialogs, and template management interfaces. Should be descriptive enough to convey the template's purpose and target use case. Typically 5-100 characters. Examples include 'Quarterly Business Review Template', 'Product Launch Playbook', or 'Employee Onboarding Program'. This is a required field that defines how users will recognize and select this template when creating new programs from it. Consider including version numbers or date indicators for evolving templates.

int32 | null

Estimated total duration for programs created from this template, measured in calendar days from start to finish. Optional field that can be null when template does not specify a standard duration. When specified, this value becomes the default plannedDuration for all programs instantiated from this template, though users can override it during program creation. Use to standardize execution timeframes for common program types, establish duration expectations for recurring initiatives, and support resource planning. Examples: 30 for monthly campaigns, 90 for quarterly programs, 365 for annual initiatives. Set to null for ad-hoc templates with variable duration.

string | null

Unique identifier of the user who should be assigned as the default program manager for programs created from this template. Optional field that can be null when no default manager should be pre-assigned. When specified, programs instantiated from this template will have this user automatically set as the manager, though it can be changed during or after program creation. Use to standardize ownership for recurring program types, ensure appropriate oversight is established by default, and reduce manual assignment steps. Set to null for templates used across multiple teams where manager varies by context.

string | null

Detailed textual explanation of the program template's purpose, typical use cases, key features, and guidance for users selecting or applying this template. Optional field that can be null for self-explanatory templates. When specified, should provide comprehensive information about what programs created from this template are intended to accomplish, what phases or tasks are pre-configured, what teams or scenarios the template is designed for, and any prerequisites or considerations. Typically 100-1000 characters. Use to document template intent, provide usage guidance, differentiate similar templates, and help users select the most appropriate template for their needs. Appears in template selection dialogs and template detail views.

boolean | null

Controls whether user assignments from the source program are preserved or cleared when creating the template. When true, all assignee references (program managers, task assignees, approval assigners) are removed from the template, creating a clean template without user-specific assignments. When false or null, assignee IDs are retained in the template as default assignments for programs created from it. Set to true when creating reusable templates for broad organizational use where assignees should be selected per program instance. Set to false when creating templates for specific teams where default assignees should be pre-configured. Affects task assignments, program manager fields, and ownership metadata.

boolean | null

Controls whether all content associations (documents, presentations, videos, links) from the source program are included in the template. When true, all content items linked to the program's pages and tasks are preserved in the template as default content for programs created from it. When false or null, content associations are excluded, requiring users to add content to each program instance manually. Set to true when creating templates with standardized content libraries (e.g., training programs with fixed curriculum materials, sales playbooks with standard presentations). Set to false for templates representing program structures without specific content dependencies. Affects content references on program pages, task attachments, and content libraries.

recurrence

Optional recurrence pattern configuration defining how often programs created from this template should repeat. When specified, establishes a repeating schedule (daily, weekly, monthly, quarterly, annually) for automated program generation or scheduling guidance. When null, the template creates one-time programs without recurrence. Use for templates representing periodic initiatives like monthly business reviews, quarterly planning cycles, or annual compliance programs. The Recurrence object specifies frequency, interval, and occurrence patterns following standard recurrence rules.

boolean | null

Controls whether analytics configurations (metrics, objectives, KPIs, audience segments) from the source program are included in the template. When true, the template captures all analytic settings including metric definitions, target values, date ranges, trend indicators, and audience specifications, making them default settings for programs created from the template. When false or null, analytics configurations are excluded, requiring users to configure metrics per program instance. Set to true when creating templates for standardized program types with consistent success metrics (e.g., sales enablement programs always track same KPIs). Set to false for general-purpose templates where metrics vary by use case.

pageTemplate

Optional page template configuration defining the structure, organization, and location of pages that should be automatically created when programs are instantiated from this template. When specified, the PageTemplate object includes LocationInfo (TeamSite and folder) and an array of PageTemplateModel objects defining which page templates to instantiate and what names to assign them. When null, no automatic page generation occurs for programs created from this template. Use to standardize content organization, ensure consistent page hierarchies, and automate page creation for template-based programs requiring specific content structures.

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