GuidesAPI DocsChangelogMy AppsSeismic Exchange
API Docs

Create a program template

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

Creates a new reusable program template that can be used to generate multiple programs with consistent
structure, settings, and configuration. Templates streamline program creation by providing predefined
structures, phases, and settings that can be customized when applied.

Key Features:

  • Creates reusable program templates for standardized workflows
  • Supports custom properties and configuration settings
  • Allows defining default managers and team structure
  • Includes associations to content and other resources
  • Preserves template structure for consistent program creation
  • Enables recurrence settings for automated program generation
  • Maintains audit trail of template creation and modifications

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 create templates in the space

Usage Example:

Create a program template for recurring product launches, quarterly business reviews, or onboarding
programs that can be quickly instantiated with customized parameters for different teams or time periods.

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".

Body Params

Request body containing the complete program template definition including title, description, planned dates, manager assignment, custom properties, recurrence schedule, analytics settings, and page template structure. All required fields must be provided to establish a valid template. Optional fields like plannedStartDate, plannedEndDate, managerId, customProperties, recurrence, analyticSetting, and pageTemplate can be included to create more comprehensive templates with predefined configurations. The template structure will be used as the blueprint when creating new programs from this template. Must conform to CreateProgramTemplate schema with valid property values and proper data types.

string

Display title name for the program template being created, used when listing and selecting templates in template galleries, selection dialogs, and template management interfaces. Should be concise yet descriptive of the template's purpose and use case. Required field typically ranging from 3-80 characters. Examples include 'Quarterly Business Review Template', 'Product Launch Blueprint', 'Onboarding Program Template'. This title helps users identify and select appropriate templates when creating new programs from templates. Cannot be empty or whitespace-only. The title becomes the default name for programs created from this template.

string | null

Detailed textual explanation of the template's purpose, intended use cases, what type of programs it's designed for, and any guidance for users creating programs from this template. Plain text format supporting multi-line content with typical length of 50-500 characters. Optional field (nullable) that provides context beyond the title to help users understand when and how to use this template. Examples include describing target scenarios, recommended customizations, or best practices for template usage. Used in template selection dialogs, template details views, and documentation. Can be null or omitted if the title is self-explanatory.

date-time | null

Default start date and time to pre-populate when creating programs from this template, represented in ISO 8601 format (e.g., '2025-01-15T00:00:00Z'). Optional field (nullable) that provides a starting point for program timing which users can adjust when creating programs. Useful for templates tied to recurring events or standard schedules. Can be null if no default start date is appropriate. When creating a program from the template, this value initializes the program's plannedStartDate but can be overridden.

date-time | null

Default completion date and time to pre-populate when creating programs from this template, represented in ISO 8601 format (e.g., '2025-03-31T23:59:59Z'). Optional field (nullable) that provides a default timeline endpoint which users can adjust during program creation. Should be chronologically after plannedStartDate when both are provided. Can be null if no default end date is appropriate. Used to establish typical program duration expectations for this template type.

string | null

Default manager identifier to pre-assign when creating programs from this template, using GUID format (e.g., 'c94f35e8-6d4a-4b2e-9f1a-7e8d9c2b1a3f'). Optional field (nullable) that enables templates to specify a default program owner or manager role which can be changed during program creation. Useful for templates associated with specific organizational roles or departments. Can be null if no default manager assignment is appropriate. References an existing user in the system who will typically oversee programs of this type.

customProperties
array of objects | null

Array of default custom field values to pre-populate when creating programs from this template, enabling templates to carry standard metadata such as budget categories, strategic themes, or departmental tags. Each entry references a custom property definition and provides default value(s) that users can modify during program creation. Optional field (nullable) that helps ensure consistent categorization across similar programs. Empty array or null indicates no default custom properties. Enables template-driven standardization of program metadata.

customProperties
int32 | null

Default expected duration in calendar days to pre-populate when creating programs from this template, represented as a positive integer value using int32 format. Optional field (nullable) that establishes typical timeline expectations for programs created from this template. Typical range is 1-365 days for most templates. When programs are created from the template, this value initializes the program's plannedDuration but can be adjusted. Useful for templates representing standardized initiatives with consistent timeframes such as 30-day onboarding or 90-day product launches. Can be null if duration varies significantly. Must be positive integer when specified.

associations
array of objects | null

Array of default entity associations to include when creating programs from this template, establishing standard relationships with content, resources, or reference materials that typically accompany this program type. Each association specifies a spaceId, nodeId, and nodeType to create initial connections. Optional field (nullable) that enables templates to include starter content or required resources. Empty array or null indicates no default associations. Useful for templates that always require certain documentation or deliverables.

associations
recurrence

Recurrence schedule configuration for this template defining automated program creation frequency, timing, and repetition rules such as daily, weekly, monthly, quarterly, or annual patterns. Optional field (nullable) that enables templates to automatically generate new programs on a regular schedule without manual intervention. References Recurrence schema for detailed frequency, start date, cadence, and day-of-week/month settings. Can be null for one-time or manually-triggered templates. Essential for recurring initiatives like quarterly business reviews, monthly reports, or annual planning cycles.

analyticSetting

Default analytics, tracking, and reporting configuration to apply to programs created from this template, including launch dates, phases, KPIs, audiences, topics, trackers, and program type classification. Optional field (nullable) that enables templates to standardize tracking and reporting across similar program types. When programs are created from the template, these settings provide consistent analytics structure. References ProgramAnalyticSettingInput schema for detailed configuration. Can be null if standard tracking without template-driven analytics is sufficient. Supports template-driven analytics standardization.

pageTemplate

Page structure and layout template defining the default page organization, hierarchy, and content structure for programs created from this template. Optional field (nullable) that enables templates to pre-configure page layouts, sections, and content organization patterns. References PageTemplate schema for page structure details including TeamSite IDs and content view configurations. Can be null if programs should start with blank or default page structures. Useful for templates requiring specific content organization such as structured reports or standardized program dashboards.

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