Preview the page template

Renders the full link page as HTML, without saving anything. Renders the posted body and
css; whatever is omitted comes from the saved draft (or the starter template if the saved
draft is empty or the project has no page template). The page is rendered for a sample link,
unless you pass link_id. The preview never redirects and never collects a fingerprint.

Asset URLs in the HTML are absolute, so it can be shown in a webview or a srcdoc iframe.
The HTML includes our page scripts, so show it in a sandboxed iframe
(<iframe sandbox="allow-scripts" srcdoc="...">) to keep them out of your own origin.

The request body is optional. When you send one, send Content-Type: application/json.
Saving, publishing and previewing share a limit of 60 requests per minute per API key.

Requirements: a Pro plan, page templates enabled for the project, and an API key of a project
owner or manager with the page_templates.show scope. Previewing with link_id also needs the
links.show scope.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string

Liquid and HTML for the page body, at most 65,536 bytes (UTF-8, so fewer characters if you
use non-ASCII text). Must include {% store_buttons %} at the top level. Omit to keep the
current value; send an empty string to clear it. null is rejected.

string

Plain CSS for the page, at most 32,768 bytes. Omit to keep the current value; send an empty
string to clear it. null is rejected.

string
enum
Defaults to ios

Device the page is rendered for

Allowed:
Responses

400

Unknown platform, or link_id, platform, body or css is not a string

401

Unauthorized, or the project can't use page templates

404

Link not found

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json