Update Template

PUT

templates

{id}

curl --request PUT \
  --url https://api.doczilla.app/v1/templates/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "output": "PDF",
  "variables": {
    "page": {
      "url": "<string>",
      "html": "<string>",
      "htmlTemplate": "<string>",
      "templateData": {},
      "waitUntil": "auto",
      "waitForMilliseconds": 2500,
      "waitForSelector": {
        "selector": "<string>",
        "options": {
          "visible": false,
          "hidden": false,
          "timeout": 10000
        }
      },
      "waitForFunction": {
        "pageFunction": "window.innerWidth < 100",
        "options": {
          "polling": "raf",
          "timeout": 10000
        }
      },
      "headers": {
        "x-foo": "bar"
      },
      "adblock": true,
      "javascript": true,
      "cookies": [
        {
          "name": "<string>",
          "value": "<string>",
          "domain": "<string>",
          "url": "<string>",
          "path": "<string>",
          "secure": true,
          "httpOnly": true,
          "sameSite": "Strict",
          "expires": 123
        }
      ],
      "authentication": {
        "username": "<string>",
        "password": "<string>"
      },
      "colorScheme": "<string>",
      "mediaType": "screen",
      "timezone": "<string>"
    },
    "screenshot": {
      "type": "png",
      "device": "Macbook Pro 16",
      "viewport": {
        "width": 2240,
        "height": 1260,
        "deviceScaleFactor": 1,
        "isMobile": false,
        "hasTouch": false,
        "isLandscape": false
      },
      "fullPage": false,
      "fromSurface": true,
      "omitBackground": false,
      "optimizeForSpeed": true,
      "quality": 50,
      "captureBeyondViewport": false,
      "clip": {
        "scale": 1,
        "width": 2240,
        "height": 1260,
        "x": 123,
        "y": 123
      },
      "element": "<string>",
      "overlay": {
        "background": "<string>",
        "filter": "none",
        "margin": 0.2,
        "browser": "light",
        "screenshotBorderRadius": 0
      }
    },
    "pdf": {
      "scale": 1,
      "displayHeaderFooter": false,
      "headerHtml": "<string>",
      "footerHtml": "<string>",
      "printBackground": false,
      "landscape": false,
      "pageRanges": "1-5",
      "format": "letter",
      "width": "<string>",
      "height": "<string>",
      "preferCSSPageSize": false,
      "margin": {
        "top": "<string>",
        "bottom": "<string>",
        "left": "<string>",
        "right": "<string>"
      },
      "omitBackground": false,
      "outline": false,
      "tagged": false
    }
  }
}'

This response has no body data.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

string

required

Body

application/json

name

string

The name of the template.

Maximum length: 200

output

enum<string>

The output format of the template.

Available options:

PDF,

IMAGE

variables

object

The variables of the template.

variables.page

object

required

Page options, either provide the url, html or htmlTemplate option.

variables.page.url

string | null

URL to go to. Should include the scheme, e.g. https://

variables.page.html

string | null

HTML to render. Needs to be base64 encoded!

variables.page.htmlTemplate

string | null

HTML template to render, uses Handlebars to render your HTML together with the provided templateData. Needs to be base64 encoded!

variables.page.templateData

object | null

Template data, only used in combination with page.htmlTemplate.

variables.page.waitUntil

enum<string>

default:

auto

When to consider waiting succeeds.

auto our smart waiting option that can handle 90% of the cases.
load waits for the 'load' event.
domcontentloaded waits for the 'DOMContentLoaded' event.
networkidle0 waits till there are no more than 0 network connections for at least 500 ms.
networkidle2 waits till there are no more than 2 network connections for at least 500 ms.

Available options:

auto,

load,

domcontentloaded,

networkidle0,

networkidle2

variables.page.waitForMilliseconds

number | null

Wait for a certain amount of milliseconds before the request continues.

Required range: 0 < x < 5000

variables.page.waitForSelector

object

Wait for the selector to appear in page. If the selector doesn't appear after the timeout milliseconds of waiting, the request will continue.

variables.page.waitForFunction

object

Wait for the pageFunction to execute in the page. If the pageFunction doesn't execute successfully after the timeout milliseconds of waiting, the request will continue.

variables.page.headers

object | null

An object containing additional HTTP headers to be sent with every request. All header values must be strings.

variables.page.adblock

boolean

default:

true

Use our build-in adblocker.

variables.page.javascript

boolean

default:

true

Whether or not to enable JavaScript on the page.

variables.page.cookies

object[] | null

Cookies added to the page, Also accepted as string inside headers.cookie.

variables.page.authentication

object

Provide credentials for HTTP authentication.

variables.page.colorScheme

string | null

Color-scheme to set on the page.

Maximum length: 20

variables.page.mediaType

enum<string> | null

Changes the CSS media type of the page.

Available options:

screen,

print

variables.page.timezone

string | null

Changes the timezone of the page. See ICU’s metaZones.txt for a list of supported timezone IDs.

variables.screenshot

object

variables.screenshot.type

enum<string> | null

default:

png

Available options:

png,

jpeg,

webp

variables.screenshot.device

enum<string> | null

default:

Macbook Pro 16

Device preset to use, will not be set when viewport option is provided!

Available options:

Blackberry PlayBook,

Blackberry PlayBook landscape,

BlackBerry Z30,

BlackBerry Z30 landscape,

Galaxy Note 3,

Galaxy Note 3 landscape,

Galaxy Note II,

Galaxy Note II landscape,

Galaxy S III,

Galaxy S III landscape,

Galaxy S5,

Galaxy S5 landscape,

Galaxy S8,

Galaxy S8 landscape,

Galaxy S9+,

Galaxy S9+ landscape,

Galaxy Tab S4,

Galaxy Tab S4 landscape,

iPad,

iPad landscape,

iPad (gen 6),

iPad (gen 6) landscape,

iPad (gen 7),

iPad (gen 7) landscape,

iPad Mini,

iPad Mini landscape,

iPad Pro,

iPad Pro landscape,

iPad Pro 11,

iPad Pro 11 landscape,

iPhone 4,

iPhone 4 landscape,

iPhone 5,

iPhone 5 landscape,

iPhone 6,

iPhone 6 landscape,

iPhone 6 Plus,

iPhone 6 Plus landscape,

iPhone 7,

iPhone 7 landscape,

iPhone 7 Plus,

iPhone 7 Plus landscape,

iPhone 8,

iPhone 8 landscape,

iPhone 8 Plus,

iPhone 8 Plus landscape,

iPhone SE,

iPhone SE landscape,

iPhone X,

iPhone X landscape,

iPhone XR,

iPhone XR landscape,

iPhone 11,

iPhone 11 landscape,

iPhone 11 Pro,

iPhone 11 Pro landscape,

iPhone 11 Pro Max,

iPhone 11 Pro Max landscape,

iPhone 12,

iPhone 12 landscape,

iPhone 12 Pro,

iPhone 12 Pro landscape,

iPhone 12 Pro Max,

iPhone 12 Pro Max landscape,

iPhone 12 Mini,

iPhone 12 Mini landscape,

iPhone 13,

iPhone 13 landscape,

iPhone 13 Pro,

iPhone 13 Pro landscape,

iPhone 13 Pro Max,

iPhone 13 Pro Max landscape,

iPhone 13 Mini,

iPhone 13 Mini landscape,

iPhone 14,

iPhone 14 landscape,

iPhone 14 Plus,

iPhone 14 Plus landscape,

iPhone 14 Pro,

iPhone 14 Pro landscape,

iPhone 14 Pro Max,

iPhone 14 Pro Max landscape,

iPhone 15,

iPhone 15 landscape,

iPhone 15 Plus,

iPhone 15 Plus landscape,

iPhone 15 Pro,

iPhone 15 Pro landscape,

iPhone 15 Pro Max,

iPhone 15 Pro Max landscape,

JioPhone 2,

JioPhone 2 landscape,

Kindle Fire HDX,

Kindle Fire HDX landscape,

LG Optimus L70,

LG Optimus L70 landscape,

Microsoft Lumia 550,

Microsoft Lumia 950,

Microsoft Lumia 950 landscape,

Nexus 10,

Nexus 10 landscape,

Nexus 4,

Nexus 4 landscape,

Nexus 5,

Nexus 5 landscape,

Nexus 5X,

Nexus 5X landscape,

Nexus 6,

Nexus 6 landscape,

Nexus 6P,

Nexus 6P landscape,

Nexus 7,

Nexus 7 landscape,

Nokia Lumia 520,

Nokia Lumia 520 landscape,

Nokia N9,

Nokia N9 landscape,

Pixel 2,

Pixel 2 landscape,

Pixel 2 XL,

Pixel 2 XL landscape,

Pixel 3,

Pixel 3 landscape,

Pixel 4,

Pixel 4 landscape,

Pixel 4a (5G),

Pixel 4a (5G) landscape,

Pixel 5,

Pixel 5 landscape,

Moto G4,

Moto G4 landscape,

Macbook Pro 13,

Macbook Pro 15,

Macbook Pro 16,

iMac 21,

iMac 21 4K,

iMac 24 4.5K,

iMac 27,

iMac 27 5K

variables.screenshot.viewport

object

Define an custom viewport, when defined the device option will be ignored!

variables.screenshot.fullPage

boolean

default:

false

When true, takes a screenshot of the full page.

variables.screenshot.fromSurface

boolean

default:

true

Capture the screenshot from the surface, rather than the view.

variables.screenshot.omitBackground

boolean

default:

false

Hides default white background and allows capturing screenshots with transparency.

variables.screenshot.optimizeForSpeed

boolean

default:

true

variables.screenshot.quality

number | null

Quality of the image, between 0-100. Not applicable to png images.

Required range: 0 < x < 100

variables.screenshot.captureBeyondViewport

boolean

default:

false

Capture the screenshot beyond the viewport. false if there is no clip. true otherwise.

variables.screenshot.clip

object

Specifies the region of the page to clip.

variables.screenshot.element

string | null

It captures the DOM element matching the given CSS selector. This will overwrite the clip property and set fullPage to false. Will wait for the element to become visible for a maximum of 15 seconds.

variables.screenshot.overlay

object

Add an overlay to the image. Cannot be used together with the fullPage option!

variables.pdf

object

variables.pdf.scale

number

default:

Scales the rendering of the web page. Amount must be between 0.1 and 2.

Required range: 0.1 < x < 2

variables.pdf.displayHeaderFooter

boolean

default:

false

Whether to show the header and footer.

variables.pdf.headerHtml

string | null

HTML template for the print header. Should be valid HTML (base64 encoded) with the following classes used to inject values into them:

date formatted print date
title document title
url document location
pageNumber current page number
totalPages total pages in the document

variables.pdf.footerHtml

string | null

HTML template for the print footer. Has the same constraints and support for special classes as headerHtml.

variables.pdf.printBackground

boolean

default:

false

Set to true to print background graphics.

variables.pdf.landscape

boolean

default:

false

Whether to print in landscape orientation.

variables.pdf.pageRanges

string | null

Paper ranges to print, e.g. 1-5, 8, 11-13.

variables.pdf.format

enum<string>

default:

letter

If set, this takes priority over the width and height options. The sizes of each format are as follows:

letter 8.5in x 11in
legal 8.5in x 14in
tabloid 11in x 17in
ledger 17in x 11in
a0 33.1in x 46.8in
a1 23.4in x 33.1in
a2 16.54in x 23.4in
a3 11.7in x 16.54in
a4 8.27in x 11.7in
a5 5.83in x 8.27in
a6 4.13in x 5.83in

Available options:

letter,

legal,

tabloid,

ledger,

a0,

a1,

a2,

a3,

a4,

a5,

a6

variables.pdf.width

Sets the width of paper. You can pass in a number or a string with a unit.

variables.pdf.height

Sets the height of paper. You can pass in a number or a string with a unit.

variables.pdf.preferCSSPageSize

boolean

default:

false

Give any CSS @page size declared in the page priority over what is declared in the width or height or format option.

variables.pdf.margin

object

Set the PDF margins.

variables.pdf.omitBackground

boolean

default:

false

Hides default white background and allows generating pdfs with transparency.

variables.pdf.outline

boolean

default:

false

Generate document outline. If this is enabled the PDF will also be tagged (accessible).

variables.pdf.tagged

boolean

default:

false

Generate tagged (accessible) PDF. This is experimental and will increase the size of the PDF.

Was this page helpful?

Get Template Delete Template

curl --request PUT \
  --url https://api.doczilla.app/v1/templates/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "output": "PDF",
  "variables": {
    "page": {
      "url": "<string>",
      "html": "<string>",
      "htmlTemplate": "<string>",
      "templateData": {},
      "waitUntil": "auto",
      "waitForMilliseconds": 2500,
      "waitForSelector": {
        "selector": "<string>",
        "options": {
          "visible": false,
          "hidden": false,
          "timeout": 10000
        }
      },
      "waitForFunction": {
        "pageFunction": "window.innerWidth < 100",
        "options": {
          "polling": "raf",
          "timeout": 10000
        }
      },
      "headers": {
        "x-foo": "bar"
      },
      "adblock": true,
      "javascript": true,
      "cookies": [
        {
          "name": "<string>",
          "value": "<string>",
          "domain": "<string>",
          "url": "<string>",
          "path": "<string>",
          "secure": true,
          "httpOnly": true,
          "sameSite": "Strict",
          "expires": 123
        }
      ],
      "authentication": {
        "username": "<string>",
        "password": "<string>"
      },
      "colorScheme": "<string>",
      "mediaType": "screen",
      "timezone": "<string>"
    },
    "screenshot": {
      "type": "png",
      "device": "Macbook Pro 16",
      "viewport": {
        "width": 2240,
        "height": 1260,
        "deviceScaleFactor": 1,
        "isMobile": false,
        "hasTouch": false,
        "isLandscape": false
      },
      "fullPage": false,
      "fromSurface": true,
      "omitBackground": false,
      "optimizeForSpeed": true,
      "quality": 50,
      "captureBeyondViewport": false,
      "clip": {
        "scale": 1,
        "width": 2240,
        "height": 1260,
        "x": 123,
        "y": 123
      },
      "element": "<string>",
      "overlay": {
        "background": "<string>",
        "filter": "none",
        "margin": 0.2,
        "browser": "light",
        "screenshotBorderRadius": 0
      }
    },
    "pdf": {
      "scale": 1,
      "displayHeaderFooter": false,
      "headerHtml": "<string>",
      "footerHtml": "<string>",
      "printBackground": false,
      "landscape": false,
      "pageRanges": "1-5",
      "format": "letter",
      "width": "<string>",
      "height": "<string>",
      "preferCSSPageSize": false,
      "margin": {
        "top": "<string>",
        "bottom": "<string>",
        "left": "<string>",
        "right": "<string>"
      },
      "omitBackground": false,
      "outline": false,
      "tagged": false
    }
  }
}'

This response has no body data.

Get Started

Templating

API Documentation

Sync/Async options

Screenshot

PDF

Template

Manage Templates

Authorizations

Path Parameters

Body