GuidesAPI DocsChangelogMy AppsSeismic Exchange
API Docs

Create a program

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

Creates a new program with the specified title, description, manager, dates, custom properties, associations,
phases, analytics settings, and Slack integrations. Programs serve as containers for tasks, content, and requests
within content planning workflows. This endpoint supports comprehensive program configuration including custom
properties, workflow phases, and team collaboration features.

Key Features:

  • Creates programs with full metadata including title, description, and planned dates
  • Assigns program managers for ownership and accountability
  • Supports custom properties for flexible program categorization
  • Enables content and task associations at creation time
  • Configures workflow phases for structured program progression
  • Sets up analytics tracking with launch dates and outcome metrics
  • Integrates with Slack channels for team notifications
  • Configures object-level permissions for granular access control

Authorization Logic:

  1. User must have a valid JWT token with management scopes
  2. User must have program update permissions
  3. If managerId is provided, the manager must be a valid user in the tenant
  4. User must have permission to create programs in the space

Usage Example:

Create a new marketing campaign program with planned dates, assigned manager, custom properties for campaign type,
and Slack integration for team collaboration. Include initial content associations and workflow phases.

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

The program data to create including title, description, manager, dates, custom properties, associations, and settings.

string

Human-readable title name for the program being created, used throughout the UI as the primary display label and in program lists, searches, and reports. Should be concise yet descriptive of the program's purpose. Required field that typically ranges from 5-100 characters. Examples include 'Q1 2025 Product Launch', 'New Hire Onboarding', 'Annual Sales Kickoff'. Cannot be empty or whitespace-only. This title becomes the program's primary identifier for users and appears in notifications, dashboards, and analytics reports.

string | null

Detailed textual description of the program's purpose, objectives, scope, and any relevant context that helps stakeholders understand what the program entails and its intended outcomes. Plain text format supporting multi-line content with typical length of 50-500 characters, though longer descriptions are acceptable. Optional field (nullable) that provides additional context beyond the title. Examples include outlining target audience, key deliverables, success criteria, or strategic alignment. Used in program details views, tooltips, and documentation. Can be null or omitted if not needed.

date-time | null

Anticipated start date and time when the program is scheduled to begin, represented in ISO 8601 format (e.g., '2025-01-15T00:00:00Z'). Optional field (nullable) used for planning, scheduling, timeline visualization, and calculating program duration. When provided with plannedEndDate, enables automatic calculation of plannedDuration. Used in calendar views, Gantt charts, and program roadmaps. Can be null if start date is not yet determined or program has flexible timing. Supports full date-time precision including timezone.

date-time | null

Target completion date and time when the program is expected to finish, represented in ISO 8601 format (e.g., '2025-03-31T23:59:59Z'). Optional field (nullable) used for deadline tracking, milestone planning, and timeline management. Should be chronologically after plannedStartDate when both are provided. Enables duration calculation and supports program completion monitoring and alerts. Used in calendar views, deadline tracking systems, and progress reports. Can be null if end date is not yet determined or program has open-ended timeline. Supports full date-time precision including timezone.

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. Uses GUID format (e.g., 'c94f35e8-6d4a-4b2e-9f1a-7e8d9c2b1a3f') to reference an existing user in the system. Optional field (nullable) that enables assignment of accountability, notification routing for program updates, and permission management. The manager typically has elevated permissions to edit program details, manage tasks, and coordinate team members. Can be null if no manager is assigned at creation time.

customProperties
array of objects | null

Array of custom field values to assign to the program at creation time, enabling organizations to capture business-specific metadata beyond standard program fields such as budget codes, cost centers, campaign IDs, strategic themes, or regional classifications. Each entry references a custom property definition (by ID) configured in the space and provides corresponding value(s). Optional field (nullable) that supports single-select, multi-select, and free-form custom fields. Enables flexible categorization, reporting, and filtering based on organization-specific taxonomy. Empty array or null indicates no custom properties assigned.

customProperties
int32 | null

Expected length of the program measured in calendar days from start to end, represented as a positive integer value using int32 format. Optional field (nullable) used for planning, resource allocation, and timeline visualization. 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. Used in duration-based reports, capacity planning, and program comparison analytics. Can be null if duration is not yet determined or program timing is flexible. Must be positive integer when specified.

associations
array of objects | null

Array of entity associations to link to the program at creation time, establishing relationships between the program and existing content, entities, or resources within the workspace. Each association specifies a spaceId, nodeId, and nodeType (e.g., 'content', 'task', 'request') to create explicit connections. Optional field (nullable) that enables programs to reference related materials, deliverables, or dependencies from creation. Used for content tracking, resource management, and establishing program scope. Empty array or null indicates no initial associations. Associations can be added or modified after program creation through dedicated endpoints.

associations
analyticSetting

Configuration object for program analytics, tracking, and reporting settings including launch date, phases, KPIs, audiences, topics, trackers, and program type classification. Optional field (nullable) that enables enhanced analytics capabilities such as phase-based progress tracking, audience segmentation, topic categorization, and external analytics integration. When provided, configures the program for detailed tracking and reporting. References ProgramAnalyticSettingInput schema for structure. Can be null if standard program tracking without advanced analytics is sufficient. Settings can be updated after program creation through PUT/PATCH operations.

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