Skip to main content
PUT
Update Template

Overview

Update the scene structure and content of an existing video template. This endpoint allows you to modify the template’s scene array, which defines the video’s structure, content, and visual elements.
Template Modification: Updating a template affects all future videos created from it. Existing videos created from this template will not be affected.
You need a valid API key to use this endpoint. Get your API key from the API Access page in your Pictory dashboard.

API Endpoint


Request Parameters

Path Parameters

string
required
The unique identifier of the template to updateExample: 202512230204424435786014d42904bbc95813430789fe736

Headers

string
required
API key for authentication (starts with pictai_)

Body Parameters

array of objects
required
Array of scene objects that define the template structure. Each scene represents a segment in the video template with its own content, visuals, and timing.

Response

boolean
Indicates whether the update was successful
string
Confirmation message about the update
string
The ID of the updated template

Response Examples


Code Examples

Replace YOUR_API_KEY with your actual API key that starts with pictai_

Usage Notes

Test Before Production: Always test template updates with non-production templates first to ensure the scene structure is valid and produces the expected results.
Scene Structure: The scenes array should match the structure used in Pictory projects. Refer to the Update Project endpoint documentation for scene object examples.
Version Control: Consider keeping backup copies of template configurations before making updates, especially for templates actively used in production.

Common Use Cases

1. Update Template Text Content

Modify the text content across all scenes in a template:

2. Add New Scene to Template

Add additional scenes to an existing template:

3. Batch Update Multiple Templates

Update multiple templates with similar modifications:

4. Update Template with Validation

Validate scene structure before updating:

5. Rollback Template Changes

Implement a rollback mechanism for template updates:

Best Practices

Safety Guidelines

  1. Backup First: Always backup the current template configuration before making updates
  2. Validate Structure: Validate scene structure before sending updates to prevent errors
  3. Test Changes: Test template updates in a development environment first
  4. Version Control: Maintain version history of template configurations
  5. Gradual Rollout: When updating production templates, do so gradually and monitor results

Common Pitfalls

  • ❌ No Backup: Updating without backing up the current configuration
  • ❌ Invalid Structure: Sending incorrectly structured scene objects
  • ❌ Missing Fields: Omitting required fields in scene objects
  • ❌ Production Testing: Testing changes directly on production templates

Performance Tips

  • Batch similar updates to reduce API calls
  • Cache template configurations locally to avoid repeated fetches
  • Use validation before updates to prevent failed requests
  • Implement retry logic for transient failures