GuidesAPI DocsChangelogMy AppsSeismic Exchange
API Docs

Apply a predefined program template

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

Creates a new program from a predefined (system-provided) program template with customization options.
Predefined templates offer curated, ready-to-use program structures for common workflows that can be
quickly instantiated with organization-specific details.

Key Features:

  • Creates programs from system-curated templates
  • Applies proven program structures for common use cases
  • Allows customization with title, description, and manager
  • Customizes planned dates and timeline
  • Adds custom associations to content and resources
  • Inherits template phases and analytics configuration
  • Returns the created program with all applied customizations

Authorization Logic:

  1. User must have a valid JWT token with viewing or management scopes
  2. User must have program update permissions
  3. User must have permission to create programs in the space

Usage Example:

Apply a predefined "Product Launch" template to quickly create a Q4 launch program
with customized title, manager, and dates, or use an "Employee Onboarding" template to set up a new hire program
with specific associations to training content.

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 predefined template to apply. Must be a valid predefined template ID.

Body Params

Request body containing configuration parameters and customizations to apply when creating a new program from the specified predefined template. Includes fields to override template defaults such as program title, description, manager assignment, planned dates, custom property values, and other program-specific settings. The request merges user-provided values with template defaults to create a fully configured program. All overrides are optional—omitted fields and will use template defaults. Must conform to ApplyPredefinedTemplateRequest with valid property values matching expected data types and formats (for example, GUID for managerId and ISO 8601 for dates).

string | null

Human-readable title for the program being created from the predefined template, used throughout the UI as the primary display label in program lists, searches, and reports. Optional field (nullable) that overrides the template's default title when provided. Should be concise yet descriptive of the program's purpose, typically 5-100 characters. When omitted or null, the program inherits the title from the predefined template definition. Used for search, display, and program identification across dashboards and notifications.

string | null

Detailed textual description of the program's purpose, objectives, scope, and context that helps stakeholders understand what the program entails. Optional field (nullable) that overrides the template's default description when provided. Plain text format supporting multi-line content, typically 50-500 characters though longer descriptions are acceptable. When omitted or null, the program inherits the description from the predefined template. Used in program details views, tooltips, and documentation to provide context beyond the title.

date-time | null

Anticipated start date and time when the program is scheduled to begin, represented in ISO 8601 format with timezone (e.g., '2025-04-01T00:00:00Z'). Optional field (nullable) that overrides the template's default start date when provided. Used for planning, scheduling, timeline visualization, and calculating program duration. When omitted or null, the program may inherit the start date from the template or leave it unset. Supports full date-time precision for accurate scheduling and calendar integration.

date-time | null

Target completion date and time when the program is expected to finish, represented in ISO 8601 format with timezone (e.g., '2025-06-30T23:59:59Z'). Optional field (nullable) that overrides the template's default end date when provided. Should be chronologically after plannedStartDate when both are specified. Used for deadline tracking, milestone planning, and timeline management. When omitted or null, the program may inherit the end date from the template or leave it unset. Essential for program completion monitoring and schedule adherence tracking.

int32 | null

Expected length of the program measured in calendar days from start to end, represented as a positive integer value. Optional field (nullable) that overrides the template's default duration when provided. Typical range is 1-365 days for most programs, though longer durations are supported for multi-year initiatives. When plannedStartDate and plannedEndDate are both provided, this field can be calculated automatically or provided explicitly. When omitted or null, the program may inherit duration from the template. Used in duration-based reports, capacity planning, and program comparison analytics. Must be positive integer when specified.

string | null

Unique identifier of the user assigned as the program manager or owner who is responsible for overseeing the program's execution, progress, and outcomes. Optional field (nullable) using GUID format (e.g., 'c94f35e8-6d4a-4b2e-9f1a-7e8d9c2b1a3f') that overrides the template's default manager when provided. References an existing user in the system who must have appropriate permissions. When omitted or null, the program may inherit the manager from the template or remain unassigned. Enables assignment of accountability, notification routing for program updates, and permission management. The manager typically has elevated permissions to edit program details and manage tasks.

customProperties
array of objects | null

Array of custom field values to assign to the program when created from the predefined template, enabling organizations to capture business-specific metadata such as budget codes, cost centers, campaign IDs, strategic themes, or regional classifications. Optional field (nullable) that supplements or overrides the template's default custom properties. Each entry references a custom property definition configured in the space and provides corresponding value(s). When omitted or null, the program inherits custom properties from the template. Enables flexible categorization, reporting, and filtering based on organization-specific taxonomy. Empty array indicates no custom properties assigned beyond template defaults.

customProperties
associations
array of objects | null

Array of entity associations to link to the program at creation time from the predefined template, establishing relationships between the program and existing content, entities, or resources within the workspace. Optional field (nullable) that supplements or overrides the template's default associations. Each association specifies a spaceId, nodeId, and nodeType (e.g., 'content', 'task', 'request') to create explicit connections. When omitted or null, the program inherits associations from the template. Used for content tracking, resource management, and establishing program scope. Empty array indicates no additional associations beyond template defaults.

associations
Responses

Updated 5 days ago

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

Updated 5 days ago