Update Template

Update an existing studio template. You can update metadata (name, description, tags), canvas dimensions, or the full page structure including elements.

Endpoint#

https://api.orshot.com/v1/studio/templates/:templateId/update

Query Parameters#

Request Examples#

// Update name, description, and tags
await fetch("https://api.orshot.com/v1/studio/templates/12345/update", {
  method: "PATCH",
  headers: {
    "Content-Type": "application/json",
    Authorization: "Bearer <ORSHOT_API_KEY>",
  },
  body: JSON.stringify({
    name: "Summer Sale Banner - Updated",
    description: "Updated promotional banner for the summer 2026 campaign",
    tags: ["sale", "summer", "promotional"]
  }),
});

Rate Limits#

URL Parameters#

Request Body Parameters#

At least one of the following parameters must be provided:

When pages_data is provided, template-level modifications are automatically recalculated from the elements. Pure metadata updates (name, description, tags) do not trigger thumbnail regeneration.

Response Fields#

Thumbnails Object Structure#

When you pass ?includeThumbnails=true and the update includes visual changes (pages_data, canvas_width, or canvas_height), the response includes a thumbnails object:

Error Responses#

Cache Invalidation#

When the template is updated:

1. Template render cache is automatically invalidated
2. Dynamic URL cache for the template is cleared

Use Cases#

• Rename templates after generation or import
• Update descriptions for better organization
• Tag templates for filtering and categorization
• Update canvas dimensions when resizing templates
• Replace page structure with updated elements and layouts
• Batch rename templates via programmatic naming conventions