ORorshot
Enterprise

Update Template

Changed on

Update template metadata, dimensions or complete page structure

Available only to Enterprise-plan workspaces and first-party clients.

patch/studio/templates/{templateId}/update

Request

  • Base URL
    https://api.orshot.com/v1
  • URL
    https://api.orshot.com/v1/studio/templates/{templateId}/update
  • Auth
    HTTP bearer

Path parameters

templateIdstring required

Query parameters

includeThumbnailsboolean

When true, the endpoint renders thumbnails synchronously and waits for all uploads before responding. When false or absent, thumbnails are generated asynchronously if visual content changed.

includeVideoThumbnailsboolean

When true, pages_data was sent and at most 2 of its pages are animated, the response waits for their animated previews and returns them in template.pages_meta[].video_thumbnail_url. Otherwise they are generated in the background.

Request body

namestring

New name for the template (max 255 characters)

descriptionstring

New description for the template

canvas_widthinteger

The template's default width in pixels, 1 to 5000. Pages that have their own canvas size keep it (every page created through the API has one). To resize a page, use Update Pages with { "op": "update", "set": { "canvas": { "width": 1200, "height": 628 } } }, or send pages_data

canvas_heightinteger

The template's default height in pixels, 1 to 5000. Same rule as canvas_width

filmobject

The template's film block, on its own or with pages_data. An object makes or changes the film; null turns it back into separate pages (each page keeps its transitionIn). Validated against the pages the template will have

base_updated_atstring

The template's updated_at from your last read. If the template changed since, nothing is written and you get 409

Response

Successful response

object required

Changes