URL Parameters Reference

This page provides a comprehensive reference of all URL parameters you can use to customize the embedded editor’s behavior and appearance.

Required Parameters

embed string
Your embed configuration ID from the dashboard. This parameter is required for all embeds.

<embed
  src="https://app.templated.io/editor?embed=YOUR_EMBED_CONFIG_ID"
  width="100%"
  height="100%"
/>

Basic Configuration

clone boolean
Create a clone instead of editing the original template. Default: false

launch-mode string
Control how the editor launches. Options: 'template-gallery', 'user-templates', 'user-renders', 'blank'

auto-save boolean
Enable automatic saving of the template at regular intervals (every 15 seconds). Default: false

Template and Content

render string
Load a specific render ID for editing (creates a template clone automatically)

folder string
Limit template selection to a specific folder ID

image-url string
URL of an image to load as background or layer

w number
Custom template width in pixels

h number
Custom template height in pixels

layers string
Base64-encoded JSON with initial layer data

metadata string
Base64-encoded JSON with custom metadata for webhooks

Permission Controls

Template Permissions

allow-rename boolean
Allow users to rename templates. Default: true

allow-save boolean
Enable the save functionality. Default: true

allow-download boolean
Enable template download. Default: true

allow-resize boolean
Allow users to resize the template dimensions. Default: false

allow-create-template boolean
Enable creating new templates from the editor. Default: true

allow-template-selection boolean
Show a Templates tab in the sidebar that opens a template selection modal, allowing users to browse and switch to a different template. Default: false

Layer Permissions

allow-layer-move boolean
Allow moving layers around the canvas. Default: false

allow-layer-resize boolean
Enable resizing of individual layers. Default: false

allow-layer-select boolean
Allow selecting layers. Default: false

allow-layer-unlock boolean
Allow users to unlock locked layers. Default: false

allow-layer-rename boolean
Enable renaming of layers. Default: false

allow-text-edition boolean
Allow double-click text editing. Default: false

UI Customization

hide-sidebar boolean
Hide the left sidebar panel. Default: false

hide-header boolean
Hide the top header bar. Default: false

hide-layers-panel boolean
Hide the layers panel. Default: false

hide-language-toggle boolean
Hide the language switcher. Default: false

language string
Set the default language for the editor. Options: 'en', 'pt', 'es', 'fr'. Default: 'en'

hide-canvas-background boolean
Hide the dotted background pattern behind the canvas. Default: false
The canvas background will be transparent and will have the same color as your parent page background color.

page-layout-mode string
Set the default layout mode for multi-page templates. Options: 'vertical', 'horizontal'. Default: 'vertical'

page string
Show only a specific page by its name or ID. Other pages will be hidden. Useful for displaying a single page from a multi-page template.

hide-tabs string
Comma-separated list of sidebar tab identifiers to hide. Available tabs: text, images, videos, shapes, vectors, uploads, qr-code, barcode, rating.
Example: &hide-tabs=barcode,qr-code,rating will hide the Barcode, QR Code, and Rating tabs.

zoom number (10-100)
Initial zoom level. 50 equals 100% scale. Auto-calculated if not set.

Integration Options

webhook-url string
Override the default webhook URL for this session

external-id string
Session identifier that tags templates, uploads, fonts, and renders. Acts as a persistent session - when the editor is launched again with the same ID, previously uploaded assets and fonts will be available

include-account-templates boolean
When used with external-id, includes both templates matching the external ID and account templates (templates without an external ID) in the initial template selection modal. Default: false

move-to-folder string
Automatically move saved templates to this folder ID

load-uploads boolean
Load user uploads in the assets panel. Default: false

Usage Examples

Preview Mode with Layer Controls

<embed
  src="https://app.templated.io/editor/preview/TEMPLATE_ID?embed=CONFIG_ID
       &zoom=60
       &allow-layer-move=true
       &allow-layer-resize=true
       &allow-text-edition=true
       &hide-sidebar=true"
  width="100%"
  height="600"
/>

Clean Canvas without Background Pattern

<embed
  src="https://app.templated.io/editor/TEMPLATE_ID?embed=CONFIG_ID
       &hide-canvas-background=true
       &hide-sidebar=true"
  width="100%"
  height="600"
/>

<embed
  src="https://app.templated.io/editor/TEMPLATE_ID?embed=CONFIG_ID
       &canvas-background=transparent"
  width="100%"
  height="600"
/>

Template Gallery with Restrictions

<embed
  src="https://app.templated.io/editor?embed=CONFIG_ID
       &launch-mode=gallery
       &allow-download=false
       &allow-resize=false
       &hide-language-toggle=true"
  width="100%"
  height="700"
/>

Folder-Specific Templates

<embed
  src="https://app.templated.io/editor?embed=CONFIG_ID
       &folder=FOLDER_ID
       &clone=true
       &allow-create-template=false"
  width="100%"
  height="700"
/>

Custom Dimensions and Image

<embed
  src="https://app.templated.io/editor?embed=CONFIG_ID
       &w=1200
       &h=800
       &image-url=https://example.com/background.jpg
       &zoom=40"
  width="100%"
  height="700"
/>

Render Editing with Session

<embed
  src="https://app.templated.io/editor?embed=CONFIG_ID
       &render=RENDER_ID
       &allow-save=true
       &move-to-folder=EDITED_RENDERS_FOLDER
       &external-id=user-456-editing-session"
  width="100%"
  height="700"
/>

Single Page from Multi-Page Template

<embed
  src="https://app.templated.io/editor/preview/TEMPLATE_ID?embed=CONFIG_ID
       &page=Cover
       &hide-sidebar=true
       &hide-header=true"
  width="100%"
  height="600"
/>

Multi-User Environment

<!-- Each client gets their own persistent session -->
<embed
  src="https://app.templated.io/editor?embed=CONFIG_ID
       &folder=CLIENT_TEMPLATES_FOLDER
       &external-id=client-acme-corp-2024
       &clone=true
       &allow-create-template=false"
  width="100%"
  height="700"
/>

Combined Account and External ID Templates

<!-- User sees both shared account templates and their own templates -->
<embed
  src="https://app.templated.io/editor?embed=CONFIG_ID
       &launch-mode=user-templates
       &external-id=user-456
       &include-account-templates=true"
  width="100%"
  height="700"
/>

<embed
  src="https://app.templated.io/editor/TEMPLATE_ID?embed=CONFIG_ID
       &hide-tabs=barcode,rating"
  width="100%"
  height="700"
/>

<embed
  src="https://app.templated.io/editor/TEMPLATE_ID?embed=CONFIG_ID
       &hide-tabs=videos,shapes,vectors,uploads,qr-code,barcode,rating"
  width="100%"
  height="700"
/>

Parameter Combinations

Common Parameter Combinations

Preview Mode for Interactive Demos:

?embed=CONFIG&preview=true&allow-layer-move=true&allow-text-edition=true&zoom=50

Restricted Editor for End Users:

?embed=CONFIG&clone=true&allow-download=false&allow-resize=false&hide-sidebar=true

Agency Client Portal:

?embed=CONFIG&folder=CLIENT_FOLDER&clone=true&allow-create-template=false&external-id=client-acme-corp

Hybrid Template Access (Account + User Templates):

?embed=CONFIG&launch-mode=user-templates&external-id=user-123&include-account-templates=true

Educational Platform:

?embed=CONFIG&launch-mode=gallery&allow-layer-unlock=true&load-uploads=true

Single Page from Multi-Page Template:

?embed=CONFIG&page=Cover&hide-sidebar=true&hide-header=true

Simplified Sidebar (Hide Advanced Tabs):

?embed=CONFIG&hide-tabs=qr-code,barcode,rating

External ID Sessions

The external-id parameter creates persistent sessions for your embedded editor instances. This is particularly useful for maintaining user context and asset continuity across multiple editor sessions.

How External ID Works

When you provide an external-id, the editor:

Tags all created content with this identifier
Persists user uploads and custom fonts for future sessions
Makes tagged entities accessible via the API using the same ID
Maintains session continuity when users return to the editor

What Gets Tagged

All content created during the session is tagged with the external ID:

Templates
Any templates created or saved during the session

Renders
All renders generated from templates in this session

Uploads
Images and assets uploaded by the user

Fonts
Custom fonts added during the session

Usage Examples

<!-- Each user gets their own persistent session -->
<embed
  src="https://app.templated.io/editor?embed=CONFIG_ID&external-id=user-123"
  width="100%"
  height="700"
/>

When user-123 returns to the editor, all their previous uploads and fonts will be available.

<!-- All work for a specific project -->
<embed
  src="https://app.templated.io/editor?embed=CONFIG_ID&external-id=project-abc-campaign"
  width="100%"
  height="700"
/>

Perfect for maintaining project-specific assets and branding consistency.

<!-- Agency managing multiple clients -->
<embed
  src="https://app.templated.io/editor?embed=CONFIG_ID&external-id=client-acme-corp"
  width="100%"
  height="700"
/>

Keep each client’s assets, fonts, and templates separate and organized.

API Integration

All entities tagged with an external ID can be retrieved via the Templated API:

// Get all templates for a specific external ID
const response = await fetch('https://api.templated.io/v1/templates?external_id=user-123', {
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY'
  }
});

const templates = await response.json();

// Get all uploads for a specific external ID
const response = await fetch('https://api.templated.io/v1/uploads?external_id=project-abc-campaign', {
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY'
  }
});

const uploads = await response.json();

Best Practices

External ID Best Practices

Naming Convention:

Use descriptive, unique identifiers
Include context: user-{id}, project-{name}, client-{company}
Avoid special characters that might cause URL encoding issues

Session Management:

Use the same external ID consistently for the same user/project/client
Consider implementing session cleanup for inactive external IDs
Document your external ID strategy for your team

API Integration:

Use external IDs to filter API responses
Implement external ID-based data exports
Consider external IDs in your backup and archival strategies

Data Encoding

For parameters that accept JSON data (layers, metadata), you must base64-encode the JSON string:

JavaScript
Python

const layerData = {
  "headline": { text: "Custom Title", color: "#FF0000" },
  "description": { text: "Custom description text" }
};

const encodedLayers = btoa(JSON.stringify(layerData));
const embedUrl = `https://app.templated.io/editor/TEMPLATE_ID?embed=CONFIG_ID&layers=${encodedLayers}`;

import json
import base64

layer_data = {
    "headline": {"text": "Custom Title", "color": "#FF0000"},
    "description": {"text": "Custom description text"}
}

encoded_layers = base64.b64encode(
    json.dumps(layer_data).encode('utf-8')
).decode('utf-8')

embed_url = f"https://app.templated.io/editor/TEMPLATE_ID?embed=CONFIG_ID&layers={encoded_layers}"

URL Parameters Reference

Required Parameters

Basic Configuration

Template and Content

Permission Controls

Template Permissions

Layer Permissions

UI Customization

Integration Options

Usage Examples

Preview Mode with Layer Controls

Clean Canvas without Background Pattern

Template Gallery with Restrictions

Folder-Specific Templates

Custom Dimensions and Image

Render Editing with Session

Single Page from Multi-Page Template

Multi-User Environment

Combined Account and External ID Templates

Hiding Specific Sidebar Tabs

Parameter Combinations

External ID Sessions

How External ID Works

What Gets Tagged

Usage Examples

API Integration

Best Practices

Data Encoding

See Also